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

Updates #5

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

Updates #5

wants to merge 38 commits into from

Conversation

cvn
Copy link

@cvn cvn commented Feb 12, 2018

Hi @Moddus,

I've been enjoying the TLDR pages docset. I wanted to create an updated version, and along the way I fixed a few issues with the generator, and added some features too. Here's a summary of the changes:

  • update the styles (see example below)
  • add support for online redirection, to make it easy to get to the source documents from Dash
  • fix encoding issues e.g. that’s -> that’s (ditto)
  • fix underscore issues e.g. day_of_week -> day_of_week instead of dayofweek (crontab)
  • add a table of contents to the index page
  • make sure the index page is always in alphabetical order
  • add config files for Docker and pip, to make it easier to get started, and lay a foundation for automated builds via CI

I plan to submit a new version to the Dash-User-Contributions repo in the next few days. If you would like to do that instead, just mention me in the PR so I know about it.

Let me know if you have any questions.

Chad


screenshot 2018-02-12 15 22 41

- support inline code elements
- add bottom margin to page
- remove unused styles
- e.g. isn’t -> isn’t
- does not handle nested brackets e.g.  `{{a {{b}} c}}`, but did not find any instances of this in tldr pages

close Moddus#4
- fix font inheriting for elements inside a `code` element
- use endash (–) instead of asterisk (*) for list items
- match left padding for description and code snippets, also improves wrapping
- use same font size for small and large screens. before, fonts were larger for small screens
- add fallback generic fonts
- day_of_week now works, previously was rendered as dayofweek with "of" being italicized
- https://github.com/trentm/python-markdown2/wiki/code-friendly
- COPY is less magical and is recommended by Docker
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.

None yet

1 participant