steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-04-05 11:41:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
just-the-docs/_sass/vendor/OneDarkJekyll/README.md
Peter Mosses 70b34f01f7
Combination (#578) 
This PR combines (and resolves conflicts between) #448, #463, #466, #494, #495, #496, #498, and #572. 

The main aim is to facilitate use of several of the implemented features _together_, when using the fork as a remote theme. It should also simplify merging the included PRs into a future release.

The branch [combination-rec-nav](https://github.com/pdmosses/just-the-docs/tree/combination-rec-nav) adds [multi-level navigation](https://github.com/pmarsceill/just-the-docs/pull/462) and (NEW:) [sibling links](https://github.com/pmarsceill/just-the-docs/pull/394) to the branch used for this PR. It includes updated [documentation for the navigation structure](https://pdmosses.github.io/just-the-docs/docs/navigation-structure/), and reorganised and extended [navigation tests](https://pdmosses.github.io/just-the-docs/tests/navigation/). The documentation and the tests can be browsed at the (temporary) [website published from the combination-rec-nav branch](https://pdmosses.github.io/just-the-docs/).

_Caveat:_ The changes to v0.3.3 in this PR and #462 have not yet been reviewed or approved, and may need updating before merging into a release of the theme. If you use a branch from a PR as a remote theme, there is a risk of such updates affecting your website. Moreover, these branches are likely to be deleted after they have been merged. To avoid  such problems, you could copy the branch that you want to use to your own fork of the theme.

Co-authored-by: Matt Wang <matt@matthewwang.me>
2022-07-04 12:15:10 -07:00

1.0 KiB
Raw Blame History

OneDarkJekyll

Use Atom's One Dark syntax colors in your Jekyll powered blog!

It's LESS file which can be compiled to a - Pygments, Rouge compatible - stylesheet from Atom editor's One Dark syntax theme (and any theme based on it, for example One Dark Vivid, Firewatch, etc.).

Download the stylesheet files or compile a new one from any Atom syntax theme which based on One Dark (the variable names in colors.less must match with One Dark's)

Create a new syntax stylesheet

  1. npm install -g less less-plugin-clean-css
  2. Clone this repository
  3. Download the colors.css file from the syntax theme's repository (for example https://github.com/atom/one-dark-syntax/blob/master/styles/colors.less in case of One-Dark)
  4. Put the previously downloaded file next to syntax.less
  5. Run lessc syntax.less syntax.css --clean-css
  6. Use the syntax.css

It's not final and in case you find any error/improvement feel free to create a PR. :)

UPDATES FOR USE IN JUST-THE-DOCS:

  1. Layout added in *.css
  2. Renamed *.css to *.scss