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

[FEATURE] Generate docs sub project #15

Open
6 tasks
mationorato opened this issue Oct 31, 2022 · 1 comment
Open
6 tasks

[FEATURE] Generate docs sub project #15

mationorato opened this issue Oct 31, 2022 · 1 comment
Assignees

Comments

@mationorato
Copy link
Contributor

🚀 Feature

Generate a subproject for documentation purposes.

Motivation

To have a subproject for handling the docs from now on

Implementation

  • run npm init inside docs folder
  • install jsdoc and all the packages needed inside there
  • generate docs inside docs running npm run build
  • make prettier and eslint to ignored this folder
  • use docs/readme.md as the docs main page
  • check that the github pages works correctly
@mationorato
Copy link
Contributor Author

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

2 participants