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.

Sign up for GitHub

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

Jump to bottom

Workflow for developing website #9

Closed
alecjacobson opened this issue Oct 28, 2018 · 2 comments
Closed

Workflow for developing website #9

alecjacobson opened this issue Oct 28, 2018 · 2 comments

Comments

@alecjacobson
Copy link
Contributor

Since the .html and the .md live in different branches, I'm struggling to find a good workflow for developing the library.

Suppose I've checked out the docs branch and then make a change to tutorial.md, what's the best practice for previewing my change on the .html website?
@jdumas
Copy link
Collaborator

jdumas commented Oct 28, 2018

You can preview locally the website on your computer by running a local python server with python3 -m mkdocs serve from the root folder. There is also a one-to-one mapping between the file path in the docs/ folder and the urls on the website, so it should be easy to find which is which. When browsing the website you can also click the "edit" button on the top right and it will open the github text editor where you can do a quick correction and push/create a PR for it.

@jdumas
Copy link
Collaborator

jdumas commented May 23, 2019

@alecjacobson any interrogation left on this issue, or can we close it?

@jdumas jdumas closed this as completed Dec 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jdumas @alecjacobson