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

doc,tools: properly syntax highlight API ref docs #33442

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -737,7 +737,7 @@ out/doc/api/assets:

# If it's not a source tarball, we need to copy assets from doc/api_assets
out/doc/api/assets/%: doc/api_assets/% out/doc/api/assets
@cp $< $@
@cp $< $@ ; $(RM) out/doc/api/assets/README.md


run-npm-ci = $(PWD)/$(NPM) ci
Expand Down
27 changes: 27 additions & 0 deletions doc/api_assets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# API Reference Document Assets

## highlight.pack.js

_Generated by [highlightjs.org/download][] on 2020-05-16._

Grammars included in the custom bundle:

* Bash
* C
* C++
* CoffeeScript
* JavaScript
* JSON
* Markdown
* Plaintext
* Shell Session

## sh.css

The syntax theme for code snippets in API reference documents.

## style.css

The main stylesheet for API reference documents.

[highlightjs.org/download]: https://highlightjs.org/download/
6 changes: 6 additions & 0 deletions doc/api_assets/highlight.pack.js

Large diffs are not rendered by default.

16 changes: 7 additions & 9 deletions doc/api_assets/sh.css
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
.sh_sourceCode {
.hljs {
DerekNonGeneric marked this conversation as resolved.
Show resolved Hide resolved
font-weight: normal;
font-style: normal;
}

.sh_sourceCode .sh_symbol,
.sh_sourceCode .sh_cbracket {
.hljs-symbol {
color: #333;
}

.sh_sourceCode .sh_keyword {
.hljs-keyword {
color: #338;
}

.sh_sourceCode .sh_string,
.sh_sourceCode .sh_regexp,
.sh_sourceCode .sh_number,
.sh_sourceCode .sh_specialchar {
.hljs-string,
.hljs-regexp,
.hljs-number {
color: #E54305;
}

.sh_sourceCode .sh_comment {
.hljs-comment {
color: #666;
font-weight: lighter;
}
1 change: 0 additions & 1 deletion doc/api_assets/sh_javascript.min.js

This file was deleted.

Loading