Skip to content

Commit b8fd9ea

Browse files
committed
Add Sitemap
1 parent e16b475 commit b8fd9ea

File tree

11 files changed

+43
-90
lines changed

11 files changed

+43
-90
lines changed

.github/workflows/lighthouse-report.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ jobs:
2121
- name: Install dependencies
2222
run: npm ci
2323

24-
- name: Build project (если нужно)
24+
- name: Build project
2525
run: npm run build
2626

2727
- name: Run Lighthouse CI
2828
uses: treosh/lighthouse-ci-action@v12
2929
with:
3030
urls: |
31-
https://example.com/
32-
https://example.com/blog
31+
https://theparazit.github.io/anomaly-modding-book/
32+
https://theparazit.github.io/anomaly-modding-book/blog
3333
uploadArtifacts: true
3434
temporaryPublicStorage: true
3535
env:

docs/forcontributors/book-style-sheet.md

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ The formatting of articles is entirely at your discretion and will not be correc
1212

1313
- For first level headings, use `Title Case` (All First Letters of Words Capitalized)
1414
- For headings after the first level, use `Sentence case` (Only the first letter of the first word and proper names)
15-
- Whenever possible, fully utilize [Markdown syntax](https://rust-lang.github.io/mdBook/format/markdown.html)
1615
- File naming in `kebab-case`
1716
- When referring to file formats, use the following extension syntax (if the file has an extension):
1817

@@ -37,33 +36,15 @@ The formatting of articles is entirely at your discretion and will not be correc
3736

3837
- Files should end with a single newline character
3938

40-
- To center the image when using markdown, you can specify `centered` in the alternate title. Example:
39+
- [Admonishments](https://docusaurus.io/docs/markdown-features/admonitions) support.
4140

4241
:::info
43-
```markdown
44-
![image centered](../path/to/image.png)
45-
```
46-
:::
47-
48-
- When using svg icons, you can specify `svg-icon` in the alternative name so that the icon will change brightness depending on the theme (for example, in a light theme the icon will be dark, in a dark theme - light). Example:
49-
50-
:::info
51-
```markdown
52-
![image svg-icon](../path/to/image.svg)
53-
```
54-
:::
55-
56-
Since the book uses additional preprocessors, the following features can be used:
57-
58-
- For admonishments (For more examples check [Admonish Reference Page](https://tommilligan.github.io/mdbook-admonish/reference.html))
59-
60-
:::info
61-
```admonish example
42+
:::info
6243
Example
63-
```
44+
:::
6445
:::
6546

66-
- There is support for [Mermaid](https://mermaid.js.org/). Example:
47+
- [Mermaid](https://mermaid.js.org/) support.
6748

6849
:::info
6950
```mermaid

docs/glossary/glossary.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Contains descriptions of various S.T.A.L.K.E.R. related terms used in modding an
7979
<td>lvid (level_vertex_id)</td>
8080
<td>
8181
Part of{" "}
82-
<a href="https://www.tablesgenerator.com/references/file-formats/game-levels/ai.md">
82+
<a href="../references/file-formats/game-levels/ai.md">
8383
*.ai
8484
</a>
8585
. AI Map node
@@ -143,7 +143,7 @@ Contains descriptions of various S.T.A.L.K.E.R. related terms used in modding an
143143
<td>Motion Reference</td>
144144
<td>
145145
Reference to the animation library (
146-
<a href="https://www.tablesgenerator.com/references/file-formats/animations/omf.md">*.omf
146+
<a href="../references/file-formats/animations/omf.md">*.omf
147147
</a>)
148148
</td>
149149
</tr>
@@ -304,7 +304,7 @@ Contains descriptions of various S.T.A.L.K.E.R. related terms used in modding an
304304
<td>Custom Data</td>
305305
<td>
306306
Custom or additional parameters (in{" "}
307-
<a href="https://www.tablesgenerator.com/references/file-formats/conf-script/ltx.md">
307+
<a href="../references/file-formats/conf-script/ltx.md">
308308
*.ltx
309309
</a>{" "}
310310
format).
@@ -438,7 +438,7 @@ Contains descriptions of various S.T.A.L.K.E.R. related terms used in modding an
438438
<td>Particle Effect</td>
439439
<td>
440440
Single Particle Effect. Stored in{" "}
441-
<a href="https://www.tablesgenerator.com/references/file-formats/particles/pe.md">
441+
<a href="../references/file-formats/particles/pe.md">
442442
*.pe
443443
</a>{" "}
444444
files.
@@ -448,7 +448,7 @@ Contains descriptions of various S.T.A.L.K.E.R. related terms used in modding an
448448
<td>Particle Group</td>
449449
<td>
450450
Particle Effects Group. Stored in{" "}
451-
<a href="https://www.tablesgenerator.com/references/file-formats/particles/pg.md">
451+
<a href="../references/file-formats/particles/pg.md">
452452
*.pg
453453
</a>{" "}
454454
files.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

docs/modding-tools/in-game-editors/npc-logic-execute.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@ ___
44

55
## About
66

7-
Отладочный интерфейс для взаимодействия с логикой NPC
7+
Debugging interface for interacting with NPC logic.
88

99
![npc-logic-execute centered](assets/images/npc-logic-execute.png)
1010

1111
### NPC Logic
1212

1313
| | |
1414
|---|---|
15-
| Active Section | Активная секция конфигурации |
16-
| Active Logic | Активная логическая схема |
17-
| INI Filename | Файл конфигурации |
18-
| Set logic | Применяет новую логику и схему к NPC |
19-
| Revert logic | Восстанавливает оригинальную логику |
15+
| Active Section | Active configuration section |
16+
| Active Logic | Active logic scheme |
17+
| INI Filename | Configuration file |
18+
| Set logic | Applies new logic and scheme to NPCs |
19+
| Revert logic | Restores the original logic |
2020

2121
### Function executer
2222

23-
Содержит текстовое поле для ввода произвольного Lua-кода.
23+
Contains a text field for entering arbitrary Lua code.
2424

2525
| | |
2626
|---|---|
27-
| Execute | Выполняет введенный код |
27+
| Execute | Executes the entered code |
2828

2929
___
3030

docusaurus.config.ts

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,19 @@ const config: Config = {
99

1010
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
1111
future: {
12-
v4: true, // Improve compatibility with the upcoming Docusaurus v4
12+
v4: true,
1313
},
1414

1515
themes: ['@docusaurus/theme-mermaid'],
1616
markdown: {
1717
mermaid: true,
1818
},
19-
url: 'https://your-docusaurus-site.example.com',
20-
// Set the /<baseUrl>/ pathname under which your site is served
21-
// For GitHub pages deployment, it is often '/<projectName>/'
19+
20+
url: 'https://theparazit.github.io',
2221
baseUrl: '/anomaly-modding-book/',
2322

2423
onBrokenLinks: 'warn',
2524
onBrokenMarkdownLinks: 'warn',
26-
27-
28-
// Even if you don't use internationalization, you can use this field to set
29-
// useful metadata like html lang. For example, if your site is Chinese, you
30-
// may want to replace "en" with "zh-Hans".
3125
i18n: {
3226
defaultLocale: 'en',
3327
locales: ['en'],
@@ -37,10 +31,20 @@ const config: Config = {
3731
[
3832
'classic',
3933
{
34+
sitemap: {
35+
lastmod: 'date',
36+
changefreq: 'weekly',
37+
priority: 0.5,
38+
ignorePatterns: ['/tags/**'],
39+
filename: 'sitemap.xml',
40+
createSitemapItems: async (params) => {
41+
const {defaultCreateSitemapItems, ...rest} = params;
42+
const items = await defaultCreateSitemapItems(rest);
43+
return items.filter((item) => !item.url.includes('/page/'));
44+
},
45+
},
4046
docs: {
4147
sidebarPath: './sidebars.ts',
42-
// Please change this to your repo.
43-
// Remove this to remove the "edit this page" links.
4448
editUrl:
4549
'https://github.com/TheParaziT/anomaly-modding-book/',
4650
},
@@ -52,11 +56,8 @@ const config: Config = {
5256
type: ['rss', 'atom'],
5357
xslt: true,
5458
},
55-
// Please change this to your repo.
56-
// Remove this to remove the "edit this page" links.
5759
editUrl:
5860
'https://github.com/TheParaziT/anomaly-modding-book/',
59-
// Useful options to enforce blogging best practices
6061
onInlineTags: 'warn',
6162
onInlineAuthors: 'warn',
6263
onUntruncatedBlogPosts: 'warn',
@@ -69,8 +70,6 @@ const config: Config = {
6970
],
7071

7172
themeConfig: {
72-
// Replace with your project's social card
73-
image: 'img/docusaurus-social-card.jpg',
7473
navbar: {
7574
title: 'Anomaly Modding Book',
7675
logo: {
@@ -142,35 +141,35 @@ const config: Config = {
142141
items: [
143142
{
144143
label: 'Glossary',
145-
to: '/docs/intro',
144+
to: '/docs/glossary/',
146145
},
147146
{
148147
label: 'Tutorials',
149-
to: '/docs/intro',
148+
to: '/docs/tutorials/',
150149
},
151150
{
152151
label: 'References',
153-
to: '/docs/intro',
152+
to: '/docs/references/',
154153
},
155154
{
156155
label: 'Modding Tools',
157-
to: '/docs/intro',
156+
to: '/docs/modding-tools/',
158157
},
159158
{
160159
label: 'Resources',
161-
to: '/docs/intro',
160+
to: '/docs/resources/',
162161
},
163162
{
164163
label: 'Engine API',
165-
to: '/docs/intro',
164+
to: '/docs/engineapi/',
166165
},
167166
{
168167
label: 'Scripting API',
169-
to: '/docs/intro',
168+
to: '/docs/scriptingapi/',
170169
},
171170
{
172171
label: 'For Contrubutors',
173-
to: '/docs/intro',
172+
to: '/docs/forcontributors/',
174173
},
175174
],
176175
},

package-lock.json

Lines changed: 0 additions & 26 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)