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

Add an HTML documentation generator based on the .md files #27

Closed
1 task done
anovikov-el opened this issue Jul 15, 2024 · 1 comment · Fixed by #41
Closed
1 task done

Add an HTML documentation generator based on the .md files #27

anovikov-el opened this issue Jul 15, 2024 · 1 comment · Fixed by #41
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested

Comments

@anovikov-el
Copy link
Contributor

anovikov-el commented Jul 15, 2024

Description

Currently, the RMK documentation is stored in https://github.com/edenlabllc/rmk/tree/develop/docs

An advanced web documentation generator might be needed in future to structure the documentation and generate a static HTML web site.

Example of the solutions:
https://pages.github.com/

Agree to the Code of Conduct

  • I agree to follow this project's Code of Conduct
@anovikov-el anovikov-el added documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested labels Jul 15, 2024
@anovikov-el anovikov-el self-assigned this Jul 22, 2024
@anovikov-el
Copy link
Contributor Author

@apanasiuk-el
After the investigation of available solutions, it became clear that:

  • the repository should be the same: it will be much easier to manage and version the documentation
  • the engine should be Material for MkDocs: the solution is already used in popular OSS projects like GoReleaser, K3D, as well as by Edenlab's Kodjin
  • visual themes, HTML generation settings, CI/CD configurations should be standard and commonly used
  • a static domain can be added in future similar to https://docs.kodjin.com/

anovikov-el added a commit that referenced this issue Aug 20, 2024
anovikov-el added a commit that referenced this issue Aug 20, 2024
anovikov-el added a commit that referenced this issue Aug 21, 2024
anovikov-el added a commit that referenced this issue Aug 21, 2024
anovikov-el added a commit that referenced this issue Aug 22, 2024
anovikov-el added a commit that referenced this issue Sep 3, 2024
development-and-release-flows.md. Strip the main README.md, rename the main web documentation file to index.md.
anovikov-el added a commit that referenced this issue Sep 3, 2024
anovikov-el added a commit that referenced this issue Sep 3, 2024
anovikov-el added a commit that referenced this issue Sep 4, 2024
anovikov-el added a commit that referenced this issue Sep 4, 2024
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 enhancement New feature or request question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant