-
-
Notifications
You must be signed in to change notification settings - Fork 222
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
pelias.io - use Material for Mkdocs #899
Comments
Also wouldn't it make sense to move the static site generator content to https://github.com/pelias/documentation ? |
Ah yeah, that's actually pretty nice. I started on a jekyll port, but I know not everyone loves Jekyll like I do :P Material for Mkdocs looks real good, I bet with a few tweaks to the colors it could be very nicely Pelias branded. Also, check how quickly/easily it can be set up in Netlify, since that's what we currently use. I'd definitely be in support of porting over the static site to it, assuming it's fairly easy to start with and supports Markdown. As for where content goes, as mentioned in pelias/documentation#262 my thought was it all moves to this repo, but as long as it's in one place and easily edited/released, it's all good. |
Hi there, 👍 Material for Mkdocs looks very good ! The interesting thing with jekyll is the native GitHub support. I have my personal website hosted on GitHub (joxit.dev), the interesting part is I've created my theme on my main repository Joxit/joxit.github.io (using bulma 😉) and I use this theme on all my projects, for example Joxit/docker-registry-ui thanks to this line in _config.yml. GitHub is mapping every projects by their name, that means my main website is In this case, with GitHub, |
Worth mentioning doks by Henk Verlinde a Hugo theme. |
The current static site generator for pelias.io could do with a replacement.
I recently stumbled upon 'Material for Mkdocs' which looks great:
https://squidfunk.github.io/mkdocs-material/getting-started/
here's and example site using it:
https://goreleaser.com/
I'd like to find something which the community feels comfortable to edit and maintain themselves, if the job falls to only the maintainers then it likely won't get much love since we're already busy with reviewing/testing etc.
The text was updated successfully, but these errors were encountered: