Skip to content
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

Auto-generate tableOfContents.md #15

Open
Andros-Spica opened this issue Dec 2, 2022 · 0 comments
Open

Auto-generate tableOfContents.md #15

Andros-Spica opened this issue Dec 2, 2022 · 0 comments

Comments

@Andros-Spica
Copy link
Collaborator

Although useful for tidying up the documentation content and displaying it online, creating and editing those files manually is a cumbersome and repetitive task for authors.

We could add extra fields (arrays) in NASSA.yml that specify the titles and/or URLs of each documentation file. Then create a workflow that generate the tableOfContents using a general Table of Contents layout and the content of these fields.

The fields could be something along these lines, keeping the differentiation between generic and implementation levels:

documentation:

  • title:
    url:

implementations:

  • language: NetLogo
    ...
    documentation:
    • title:
      url:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant