Skip to content

Commit a75d48a

Browse files
committed
update docusaurus config
1 parent f4dd513 commit a75d48a

File tree

8 files changed

+13271
-16027
lines changed

8 files changed

+13271
-16027
lines changed

docusaurus/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The automation is handled by the `generate-docs.sh` script, which processes each
88
in the schema directory and uses the `zod2md` library to convert to Markdown. The output Markdown
99
files are stored in the `docs/` directory.
1010

11-
## Setup
11+
<!-- ## Setup
1212
1313
### Requirements
1414
- [Node.js](https://nodejs.org/) v18.20
@@ -66,4 +66,4 @@ $ USE_SSH=true yarn deploy
6666
Deployment without SSH:
6767
```bash
6868
$ GIT_USER=<Your GitHub username> yarn deploy
69-
```
69+
``` -->

docusaurus/docusaurus.config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ const config: Config = {
1616
// GitHub pages deployment config.
1717
// If you aren't using GitHub pages, you don't need these.
1818
organizationName: 'MITRE ATT&CK', // Usually your GitHub org/user name.
19-
projectName: 'ATT&CK Data Model Docs', // Usually your repo name.
19+
projectName: 'attack-data-model', // Usually your repo name.
2020

2121
onBrokenLinks: 'warn',
2222
onBrokenMarkdownLinks: 'warn',
@@ -64,7 +64,7 @@ const config: Config = {
6464
items: [
6565
{
6666
type: 'docSidebar',
67-
sidebarId: 'tutorialSidebar',
67+
sidebarId: 'schemaSidebar',
6868
position: 'left',
6969
label: 'ATT&CK Schemas',
7070
},

docusaurus/package-lock.json

Lines changed: 0 additions & 14666 deletions
This file was deleted.

docusaurus/package.json

Lines changed: 0 additions & 43 deletions
This file was deleted.

docusaurus/sidebars.ts

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,36 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
22

33
const sidebars: SidebarsConfig = {
44
// By default, Docusaurus generates a sidebar from the docs folder structure
5-
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
5+
schemaSidebar: [
6+
{
7+
type: 'doc',
8+
id: 'overview'
9+
},
10+
{
11+
type: 'category',
12+
label: 'STIX Domain Objects',
13+
items: [{
14+
type: 'autogenerated',
15+
dirName: 'sdo'
16+
}],
17+
},
18+
{
19+
type: 'category',
20+
label: 'STIX Relationship Objects',
21+
items: [{
22+
type: 'autogenerated',
23+
dirName: 'sro'
24+
}],
25+
},
26+
{
27+
type: 'category',
28+
label: 'STIX Meta Objects',
29+
items: [{
30+
type: 'autogenerated',
31+
dirName: 'smo'
32+
}],
33+
},
34+
],
635
};
736

837
export default sidebars;

generate-docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ find $SCHEMA_DIR -name "*.schema.ts" | while read schemaFile; do
1818
outputFile="$OUTPUT_DIR/${relativePath/.ts/.md}"
1919

2020
# convert zod schemas to md
21-
npx zod2md --entry $schemaFile --title "$title Schema" --output "$outputFile"
21+
npx zod2md --entry $schemaFile --title "$title schema" --output "$outputFile"
2222

2323
done

0 commit comments

Comments
 (0)