search

onebeyond / systemic

📦 A minimal dependency injection framework.
https://onebeyond.github.io/systemic
MIT License
56 stars 7 forks source link

[docs] create basic documentation with docsify #29

Closed kevinccbsg closed 4 years ago

kevinccbsg commented 4 years ago

This PR includes README.md documentation in a prettier format to deploy to Github pages.

This new doc will look like this after being deployed.

Screen Shot 2020-03-18 at 20 56 32
cressie176 commented 4 years ago

Hi @kevinccbsg, Thanks for the PR, I agree the docs look better and the left hand navigation is nice, however I wouldn't want to maintain both /README.md and /docs/README.md. What are the implications of removing the README.md in the project's root directory? For example, what will render on npm.com?

kevinccbsg commented 4 years ago

Hi @kevinccbsg, Thanks for the PR, I agree the docs look better and the left hand navigation is nice, however I wouldn't want to maintain both /README.md and /docs/README.md. What are the implications of removing the README.md in the project's root directory? For example, what will render on npm.com?

Hi @cressie176, That's a good point it wouldn't be good to maintain both Readme files. What I'm going to upload is a property in the Docsify method so that /README.md will be the only one that must be maintained. 👍

cressie176 commented 4 years ago

Gonna merge. Lets see what it looks like.