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

Move Documentation into Markdown #4

Open
2 tasks
uvulpos opened this issue Jul 29, 2023 · 1 comment
Open
2 tasks

Move Documentation into Markdown #4

uvulpos opened this issue Jul 29, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@uvulpos
Copy link
Member

uvulpos commented Jul 29, 2023

As a user of this library, I want to be able to read the documentation based on the version

ACS:

  • there is a documentation in the code based on Markdown
  • it is possible to open it as a website
@uvulpos uvulpos added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jul 29, 2023
@alimy
Copy link

alimy commented Aug 7, 2023

how about docs site like go-mir docs site, it use hugo+Book theme to generate static site base on markdown documents.
The generated static site is just simple for project's document but not well as a project offical site.
docs for go-mir as a example to show Book theme for hugo and it support mutil-language translate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants