-
Notifications
You must be signed in to change notification settings - Fork 0
Add Jekyll config for GitHub Pages doc rendering #151
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| title: GNAT | ||
| description: >- | ||
| GNAT's Not A TIP — unified Python library for cyber threat intelligence | ||
| across 159 security platforms. STIX 2.1 ORM, investigations, reports, | ||
| rule engine, campaign tracking. Documentation organised with the | ||
| Diataxis framework. | ||
|
|
||
| theme: jekyll-theme-cayman | ||
|
|
||
| show_downloads: false | ||
| github: | ||
| repository_url: https://github.com/wrhalpin/GNAT | ||
|
|
||
| markdown: kramdown | ||
| kramdown: | ||
| input: GFM | ||
| syntax_highlighter: rouge | ||
|
|
||
| include: | ||
| - assets | ||
|
|
||
| exclude: | ||
| - README.md | ||
| - Gemfile | ||
| - Gemfile.lock | ||
| - node_modules | ||
| - vendor | ||
|
Comment on lines
+22
to
+27
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -62,13 +62,13 @@ <h2>Documentation by intent</h2> | |
| </tr> | ||
| <tr> | ||
| <th>Learning</th> | ||
| <td><a href="https://github.com/wrhalpin/GNAT/blob/main/docs/tutorials/README.md">Tutorials</a><br>Guided, newcomer-safe walkthroughs.</td> | ||
| <td><a href="https://github.com/wrhalpin/GNAT/blob/main/docs/explanation/README.md">Explanation</a><br>Architecture, rationale, and design choices.</td> | ||
| <td><a href="tutorials/">Tutorials</a><br>Guided, newcomer-safe walkthroughs.</td> | ||
| <td><a href="explanation/">Explanation</a><br>Architecture, rationale, and design choices.</td> | ||
| </tr> | ||
| <tr> | ||
| <th>Working</th> | ||
| <td><a href="https://github.com/wrhalpin/GNAT/blob/main/docs/how-to/README.md">How-to guides</a><br>Task-focused procedures and recipes.</td> | ||
| <td><a href="https://github.com/wrhalpin/GNAT/blob/main/docs/reference/README.md">Reference</a><br>Exact technical behavior, config, and interfaces.</td> | ||
| <td><a href="how-to/">How-to guides</a><br>Task-focused procedures and recipes.</td> | ||
| <td><a href="reference/">Reference</a><br>Exact technical behavior, config, and interfaces.</td> | ||
|
Comment on lines
+65
to
+71
|
||
| </tr> | ||
| </table> | ||
| </section> | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the docs site is expected to render/route section README.md files as landing pages, note that many existing docs link to other sections via paths ending in "README.md" (e.g., ../how-to/README.md). Jekyll typically won’t serve those source .md URLs, so cross-links may break unless you add/link-rewriting support (or standardize links to section directory URLs like "../how-to/").