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

Documentation using mkdocs #286

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

adhadse
Copy link

@adhadse adhadse commented Apr 16, 2023

👋 I did some awesome work for the Pelias project and would love for everyone to have a look at it and provide feedback.

Coming from Issue 899 this PR is intended as a proposal to merge Documentation and site hosted at pelias.io into one providing convenient experience for user searching documentation and good branded Pelias website.

Since the two repos are currently different (this repo and pelias, consider this PR as draft.

Many popular packages make sure the documentation and their landing page are on same website.


Here's the reason for this change 🚀

Fixes pelias/pelias#899

Here's what actually got changed 👏

  • Documentation and site combined with Pelias branding
  • documentation using mkdocs-material
  • CI to automatically update

Here's how others can test the changes 👀

There is a requirements.txt file, create a venv Python3 virtual environment, activate it, and run mkdocs serve.

Or simply visit: https://pelias-demo-unaffiliated.adhadse.com/ which is temporarily hosted and will be taken down once this proposal finishes.

Man doesn't it look fantastic with Pelias branding?
image

Tagging @orangejulius, @missinglink

@missinglink
Copy link
Member

Wow this looks great, I'll have a closer look next week 👍

@orangejulius
Copy link
Member

Hi @adhadse,
Absoutely, this does look great and clearly took a lot of work. Really appreciate you including all the little details like CI, and for including a hosted demo so we can see the final result.

I think @missinglink and I would have to take a look over things, and then ideally we'd help you generate a final PR against github.com/pelias/pelias. Finally we'd make a PR setting up redirects for all the documentation pages in github.com/pelias/documentation.

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

Successfully merging this pull request may close these issues.

pelias.io - use Material for Mkdocs
3 participants