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

Initial docs setup #7

Open
6 tasks
thekaveman opened this issue Nov 22, 2024 · 0 comments
Open
6 tasks

Initial docs setup #7

thekaveman opened this issue Nov 22, 2024 · 0 comments

Comments

@thekaveman
Copy link
Member

thekaveman commented Nov 22, 2024

Follow outline in https://github.com/compilerla/template-devcontainer

Depends on #3

  • mkdocs.yml, base on https://github.com/compilerla/template-devcontainer/blob/main/mkdocs.yml

  • docs/ directory

  • docs/requirements.txt with dependencies

    mdx_truly_sane_lists
    mkdocs==1.6.1
    mkdocs-awesome-pages-plugin
    mkdocs-macros-plugin
    mkdocs-material==9.5.44
    mkdocs-redirects
    
  • docs/README.md with basic information (copy repo README for now)

  • docs Compose service, starts with devcontainer, site is browsable locally

  • GitHub Actions workflow publishes docs to GitHub Pages for the repo

@github-project-automation github-project-automation bot moved this to Todo in PeMS Nov 22, 2024
@thekaveman thekaveman moved this from Todo to Stretch in PeMS Nov 22, 2024
@thekaveman thekaveman moved this from Stretch to Todo in PeMS Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

1 participant