diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..affb8fe --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +docs/** -linguist-documentation +docs/*.md linguist-detectable diff --git a/README.md b/README.md index 04efc57..11dab28 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,13 @@ Link: [101.named-data.net](https://101.named-data.net/) ## Local build Install dependencies: -```bash + +```shell poetry install --no-root ``` Live preview: -```bash + +```shell poetry run mkdocs serve ``` diff --git a/mkdocs.yml b/mkdocs.yml index 5714bd7..c247b63 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,9 +9,9 @@ theme: palette: primary: deep orange features: - - content.tabs.link - - navigation.footer - - content.code.copy + - content.tabs.link + - navigation.footer + - content.code.copy plugins: - search @@ -21,17 +21,17 @@ plugins: csl_file: acm-sig-proceedings.csl nav: - - 'index.md' - - 'getting-started.md' - - 'packets.md' - - 'communication.md' - - 'security.md' - - 'sync.md' - - 'storage.md' - - 'forwarding.md' - - 'routing.md' - - 'testbed.md' - - 'debugging.md' + - "index.md" + - "getting-started.md" + - "packets.md" + - "communication.md" + - "security.md" + - "sync.md" + - "storage.md" + - "forwarding.md" + - "routing.md" + - "testbed.md" + - "debugging.md" markdown_extensions: - admonition @@ -39,11 +39,11 @@ markdown_extensions: - pymdownx.snippets - pymdownx.superfences: custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:pymdownx.superfences.fence_code_format + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.tabbed: alternate_style: true extra_javascript: - - javascripts/iframe-message.js \ No newline at end of file + - javascripts/iframe-message.js diff --git a/pyproject.toml b/pyproject.toml index 7a68cfe..aea488f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -11,7 +11,6 @@ mkdocs-material = "^9.5.3" mkdocs-bibtex = "^2.11.0" pypandoc-binary = "^1.12" - [build-system] requires = ["poetry-core"] build-backend = "poetry.core.masonry.api"