Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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 .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ guide/book

.vscode
tests/dummy_book/book/
test_book/book/
tests/gui/books/*/book/
tests/testsuite/*/*/book/

# Ignore Jetbrains specific files.
Expand Down
6 changes: 2 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,7 @@ If you want to disable the headless mode, use the `--disable-headless-test` opti
cargo test --test gui -- --disable-headless-test
```

The GUI tests are in the directory `tests/gui` in text files with the `.goml` extension. These tests are run
using a `node.js` framework called `browser-ui-test`. You can find documentation for this language on its
[repository](https://github.com/GuillaumeGomez/browser-UI-test/blob/master/goml-script.md).
The GUI tests are in the directory `tests/gui` in text files with the `.goml` extension. The books that the tests use are located in the `tests/gui/books` directory. These tests are run using a `node.js` framework called `browser-ui-test`. You can find documentation for this language on its [repository](https://github.com/GuillaumeGomez/browser-UI-test/blob/master/goml-script.md).

### Checking changes in `.js` files

Expand Down Expand Up @@ -215,7 +213,7 @@ The following are instructions for updating [highlight.js](https://highlightjs.o
1. Compare the language list that it spits out to the one in [`syntax-highlighting.md`](https://github.com/camelid/mdBook/blob/master/guide/src/format/theme/syntax-highlighting.md). If any are missing, add them to the list and rebuild (and update these docs). If any are added to the common set, add them to `syntax-highlighting.md`.
1. Copy `build/highlight.min.js` to mdbook's directory [`highlight.js`](https://github.com/rust-lang/mdBook/blob/master/src/theme/highlight.js).
1. Be sure to check the highlight.js [CHANGES](https://github.com/highlightjs/highlight.js/blob/main/CHANGES.md) for any breaking changes. Breaking changes that would affect users will need to wait until the next major release.
1. Build mdbook with the new file and build some books with the new version and compare the output with a variety of languages to see if anything changes. The [test_book](https://github.com/rust-lang/mdBook/tree/master/test_book) contains a chapter with many languages to examine.
1. Build mdbook with the new file and build some books with the new version and compare the output with a variety of languages to see if anything changes. The [syntax GUI test](https://github.com/rust-lang/mdBook/tree/master/tests/gui/books/highlighting) contains a chapter with many languages to examine. Update the test (`highlighting.goml`) to add any new languages.

## Publishing new releases

Expand Down
51 changes: 0 additions & 51 deletions test_book/book.toml

This file was deleted.

12 changes: 0 additions & 12 deletions test_book/src/README.md

This file was deleted.

42 changes: 0 additions & 42 deletions test_book/src/SUMMARY.md

This file was deleted.

1 change: 0 additions & 1 deletion test_book/src/headings/README.md

This file was deleted.

17 changes: 0 additions & 17 deletions test_book/src/individual/README.md

This file was deleted.

30 changes: 0 additions & 30 deletions test_book/src/individual/blockquote.md

This file was deleted.

33 changes: 0 additions & 33 deletions test_book/src/individual/code.md

This file was deleted.

13 changes: 0 additions & 13 deletions test_book/src/individual/emphasis.md

This file was deleted.

21 changes: 0 additions & 21 deletions test_book/src/individual/heading.md

This file was deleted.

27 changes: 0 additions & 27 deletions test_book/src/individual/image.md

This file was deleted.

8 changes: 0 additions & 8 deletions test_book/src/individual/linebreak.md

This file was deleted.

15 changes: 0 additions & 15 deletions test_book/src/individual/link_hr.md

This file was deleted.

35 changes: 0 additions & 35 deletions test_book/src/individual/list.md

This file was deleted.

42 changes: 0 additions & 42 deletions test_book/src/individual/mathjax.md

This file was deleted.

Loading