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

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 •
edited
Loading

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

cvn added 8 commits February 8, 2018 23:28
@cvn
Add Docker files
b8313e0
@cvn
Update styles
dad15f1 
- support inline code elements
- add bottom margin to page
- remove unused styles
@cvn
Add support for online redirection
8bac0b3 
- https://kapeli.com/docsets#onlineRedirection
@cvn
Ensure alphabetical order on index page
f6ad4bb
@cvn
Fix encoding issues
2332869 
- e.g. isn’t -> isn’t
@cvn
Add title and table of contents to index page
4beeeab 
- https://kapeli.com/docsets#tableofcontents
@cvn
Style curly brackets as colored text
ee201b4 
- does not handle nested brackets e.g.  `{{a {{b}} c}}`, but did not find any instances of this in tldr pages

close Moddus#4
@cvn
Update styles
64c23e9 
- 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
cvn added 2 commits February 12, 2018 15:07
@cvn
Fix online redirection
2db7fab
@cvn
Fix text with underscores
c926e30 
- day_of_week now works, previously was rendered as dayofweek with "of" being italicized
- https://github.com/trentm/python-markdown2/wiki/code-friendly
@cvn
Use COPY instead of ADD in Dockerfile
e97ee73 
- COPY is less magical and is recommended by Docker
@cvn cvn mentioned this pull request Feb 16, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@cvn