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

Move to mkdocs #611

Merged
merged 5 commits into from
Jul 20, 2019
Merged

Move to mkdocs #611

merged 5 commits into from
Jul 20, 2019

Conversation

maebert
Copy link
Contributor

@maebert maebert commented Jul 8, 2019

This PR moves the documentation to MkDocs. This has several advantages:

  • Significantly easier and faster build process than sphinx
  • Docs are written in Markdown instead of ReST, which lowers the barrier to entry for new contributors
  • Direct deployment to github-pages

Development

pip install mkdocs
make html # opens the docs and live-reloads
make docs # builds docs and deploys them to gh-pages

This PR also

  • Consolidates doc edits from master, rc1, and rc2
  • Simplifies and modernizes the landing page
    landing
  • Modernizes the assets
  • Includes wonderful social banners for sharing on Twitter, Facebook, etc:
    image
  • Switches to a modified ReadTheDocs theme that fixes some readability issues (turns out the web has changed quite a bit since 2012...):
    docs

@maebert
Copy link
Contributor Author

maebert commented Jul 15, 2019

@wren @micahellison Anything blocking this merge? It doesn't touch functionality, but it consolidates a lot of doc edits from various branches to get a clean slate.

@wren wren changed the base branch from v2.0-rc2 to master July 16, 2019 01:11
@wren
Copy link
Member

wren commented Jul 16, 2019

@maebert Nope, I think this is a good idea. It's only held up by organizing the backlog, which has been my priority so far.

Although, I'm just a little confused about why jrnl.sh looks like it's already updated. I thought that wasn't supposed to happened until this PR was merged?

Also, I think this PR should be against master (I updated it), and it looks like it might need some rebasing.

@wren wren added this to the Docs Updates milestone Jul 16, 2019
@maebert
Copy link
Contributor Author

maebert commented Jul 16, 2019

@wren Oh damn, I think I accidentally deployed that form my branch while testing :-/

Rebased against master, should be good to go now.

- admonition
repo_url: https://github.com/jrnl-org/jrnl/
site_author: Manuel Ebert
site_description: Never Worry about Money Again.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?

Copy link
Member

@wren wren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

We should update that one line at some point, though.

@wren wren merged commit 4de6619 into master Jul 20, 2019
@wren wren deleted the manu--mkdocs branch July 20, 2019 23:07
@wren wren added the documentation Improvements or additions to documentation label Jan 10, 2020
@lock
Copy link

lock bot commented May 21, 2020

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot added the 🔒 Outdated label May 21, 2020
@lock lock bot locked as resolved and limited conversation to collaborators May 21, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation 🔒 Outdated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants