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

feat: generate documentation using docsify #17

Merged
merged 5 commits into from
Nov 18, 2024

Conversation

gmacario
Copy link
Member

@gmacario gmacario commented Nov 18, 2024

πŸ“‘ Description

Add docsify configuration to make it easier to generate HTML documentation from Markdown sources.

Closes #10

βœ… Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed

β„Ή Additional Information

@gmacario gmacario added the enhancement New feature or request label Nov 18, 2024
@gmacario gmacario self-assigned this Nov 18, 2024
@gmacario gmacario linked an issue Nov 18, 2024 that may be closed by this pull request
@gmacario gmacario requested a review from arol-varesi November 18, 2024 10:20
@gmacario
Copy link
Member Author

Checking preview site

npm i -g docsify
docsify serve docs

Result:

image

Now browse http://localhost:3000 as instructed

image

@gmacario
Copy link
Member Author

gmacario commented Nov 18, 2024

@arol-varesi and/or @aleche28 please review and merge if you like this PR. TIA!

@gmacario gmacario requested a review from aleche28 November 18, 2024 10:24
Copy link
Contributor

@arol-varesi arol-varesi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for this new feature

@arol-varesi arol-varesi merged commit e905350 into main Nov 18, 2024
14 checks passed
@arol-varesi arol-varesi deleted the 10-feat-generate-documentation-using-docsify branch November 18, 2024 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEAT]: Generate documentation using docsify
2 participants