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

Update highlight.js / hidden line rust. #1566

Merged
merged 3 commits into from
Sep 3, 2024
Merged

Update highlight.js / hidden line rust. #1566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b940cd
Update highlight.js and contribution.md file
wawel37 Aug 30, 2024
c42486f
Add cairo hidden prefix for mdbook
wawel37 Sep 2, 2024
b15c92b
Merge branch 'main' into doc/highlightjs-update
wawel37 Sep 2, 2024
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
7 changes: 5 additions & 2 deletions extensions/scarb-doc/src/docs_generation/markdown/book_toml.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use crate::AdditionalMetadata;

pub fn generate_book_toml_content(package_metadata: &AdditionalMetadata) -> String {
formatdoc! {
r#"
r##"
[book]
authors = {:?}
language = "en"
Expand All @@ -21,7 +21,10 @@ pub fn generate_book_toml_content(package_metadata: &AdditionalMetadata) -> Stri
[output.html.fold]
enable = true
level = 0
"#,

[output.html.code.hidelines]
cairo = "#"
"##,
package_metadata.authors.clone().unwrap_or_else(|| vec!["<unknown>".to_string()]),
package_metadata.name
}
Expand Down
3 changes: 3 additions & 0 deletions extensions/scarb-doc/tests/data/hello_world_no_features/book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@ runnable = false
[output.html.fold]
enable = true
level = 0

[output.html.code.hidelines]
cairo = "#"
3 changes: 3 additions & 0 deletions extensions/scarb-doc/tests/data/hello_world_sub_package_no_features/book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@ runnable = false
[output.html.fold]
enable = true
level = 0

[output.html.code.hidelines]
cairo = "#"
3 changes: 3 additions & 0 deletions extensions/scarb-doc/tests/data/hello_world_sub_package_with_features/book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@ runnable = false
[output.html.fold]
enable = true
level = 0

[output.html.code.hidelines]
cairo = "#"
3 changes: 3 additions & 0 deletions extensions/scarb-doc/tests/data/hello_world_sub_package_without_features/book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@ runnable = false
[output.html.fold]
enable = true
level = 0

[output.html.code.hidelines]
cairo = "#"
3 changes: 3 additions & 0 deletions extensions/scarb-doc/tests/data/hello_world_with_features/book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@ runnable = false
[output.html.fold]
enable = true
level = 0

[output.html.code.hidelines]
cairo = "#"
3 changes: 3 additions & 0 deletions extensions/scarb-doc/tests/data/hello_world_without_features/book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@ runnable = false
[output.html.fold]
enable = true
level = 0

[output.html.code.hidelines]
cairo = "#"
9 changes: 1 addition & 8 deletions extensions/scarb-doc/theme/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
# Contributing

If you want to modify the way that the highlighting of Cairo code sample works, you need to:

1. Clone the repository at https://github.com/highlightjs/highlight.js
2. Copy our [cairo.js](./cairo.js) into `highlight.js/src/languages` directory
3. Run `npm install`
4. Modify the copied `cairo.js`
5. Run `node tools/build.js :common apache armasm coffeescript d handlebars haskell http julia nginx nim nix properties r scala x86asm yaml cairo`
6. Replace our [highlight.js](./highlight.js) content with newly built `highlight.js/build/highlight.min.js`
If you want to modify the way that the highlighting of Cairo code sample works, you just need to change the `cairo` language definition inside the `highlight.js`.
Loading
Loading