pi-apps
pi-apps copied to clipboard
Botspot
Adding a documentation site
Cool ideas?
I’ve been experimenting with MKDocs, a site generator for documentation websites. It’s super easy to use and simple to set up.
Since there is only one long page for documentation now, I was thinking maybe we could create a formal site for it.
I created a site here: https://github.com/Pi-Apps-Coders/docs, if there are any improvements to be made or if you think this isn’t a good idea please let me know!
I think this is great! I think some of the titles need to be updated, such as The main pi apps folder. I think it might be better to just have the folder docs be titled something simpler like this: Folders: Pi-Apps (or if you can't get a dash in there: Folders: Pi Apps).
I think this is great! I think some of the titles need to be updated, such as
The main pi apps folder. I think it might be better to just have the folder docs be titled something simpler like this:Folders: Pi-Apps(or if you can't get a dash in there:Folders: Pi Apps).
Feel free to open a PR if you want. I'm wide open to any improvements :)
I think this is unnecessary... But since you've already set up the site (and it looks beautiful too), we can just add the website link in the README.
@Botspot What do you think?
Guys, make a docs folder in the repo and put markdown docs there. Then turn on github pages and connect the domain
Guys, make a docs folder in the repo and put markdown docs there. Then turn on github pages and connect the domain
@leha-code this isn't necessary. Mkdocs is a static website generator, and so it generates html and css files for the site. There is another branch of the repository for the static site: gh-pages. This is where GitHub pages is served from.
If you'd like to see how it works, take a look at the '.github/workflows/publish.yml' file in the master branch.
I know what is mkdocs, but, if you host github pages on the main branch and you have a docs folder there, it will host the docs folder
I know what is mkdocs, but, if you host github pages on the main branch and you have a docs folder there, it will host the docs folder
Hosting the docs folder will only show markdown files. Hosting the gh-pages branch will show the entire website.