mirror of
https://github.com/jj-vcs/jj.git
synced 2025-12-23 06:01:01 +00:00
docs: fix markdown sublists for the produced web pages
This commit is contained in:
parent
2518add7cf
commit
a76f2c4dac
7 changed files with 33 additions and 34 deletions
|
|
@ -72,12 +72,12 @@ use crate::ui::Ui;
|
|||
/// - `command`: The arguments used to run the tool. The first argument is the
|
||||
/// path to an executable file. Arguments can contain these variables that
|
||||
/// will be replaced:
|
||||
/// - `$root` will be replaced with the workspace root path (the directory
|
||||
/// containing the .jj directory).
|
||||
/// - `$path` will be replaced with the repo-relative path of the file
|
||||
/// being fixed. It is useful to provide the path to tools that include
|
||||
/// the path in error messages, or behave differently based on the
|
||||
/// directory or file name.
|
||||
/// - `$root` will be replaced with the workspace root path (the directory
|
||||
/// containing the .jj directory).
|
||||
/// - `$path` will be replaced with the repo-relative path of the file being
|
||||
/// fixed. It is useful to provide the path to tools that include the path
|
||||
/// in error messages, or behave differently based on the directory or file
|
||||
/// name.
|
||||
/// - `patterns`: Determines which files the tool will affect. If this list is
|
||||
/// empty, no files will be affected by the tool. If there are multiple
|
||||
/// patterns, the tool is applied only once to each file in the union of the
|
||||
|
|
|
|||
|
|
@ -1195,12 +1195,12 @@ the values have the following properties:
|
|||
- `command`: The arguments used to run the tool. The first argument is the
|
||||
path to an executable file. Arguments can contain these variables that
|
||||
will be replaced:
|
||||
- `$root` will be replaced with the workspace root path (the directory
|
||||
containing the .jj directory).
|
||||
- `$path` will be replaced with the repo-relative path of the file
|
||||
being fixed. It is useful to provide the path to tools that include
|
||||
the path in error messages, or behave differently based on the
|
||||
directory or file name.
|
||||
- `$root` will be replaced with the workspace root path (the directory
|
||||
containing the .jj directory).
|
||||
- `$path` will be replaced with the repo-relative path of the file being
|
||||
fixed. It is useful to provide the path to tools that include the path
|
||||
in error messages, or behave differently based on the directory or file
|
||||
name.
|
||||
- `patterns`: Determines which files the tool will affect. If this list is
|
||||
empty, no files will be affected by the tool. If there are multiple
|
||||
patterns, the tool is applied only once to each file in the union of the
|
||||
|
|
|
|||
|
|
@ -1881,20 +1881,20 @@ This enables features like:
|
|||
Here are some popular editors with TOML schema validation support:
|
||||
|
||||
- VS Code
|
||||
- Install [Even Better TOML](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml)
|
||||
- Install [Even Better TOML](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml)
|
||||
|
||||
- Neovim/Vim
|
||||
- Use with [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) and [taplo](https://github.com/tamasfe/taplo)
|
||||
- Use with [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) and [taplo](https://github.com/tamasfe/taplo)
|
||||
|
||||
- Helix
|
||||
- Install [taplo](https://github.com/tamasfe/taplo)
|
||||
- Install [taplo](https://github.com/tamasfe/taplo)
|
||||
|
||||
- JetBrains IDEs (IntelliJ, PyCharm, etc)
|
||||
- Install [TOML](https://plugins.jetbrains.com/plugin/8195-toml) plugin
|
||||
- Install [TOML](https://plugins.jetbrains.com/plugin/8195-toml) plugin
|
||||
|
||||
- Emacs
|
||||
- Install [lsp-mode](https://github.com/emacs-lsp/lsp-mode) and [toml-mode](https://github.com/dryman/toml-mode.el)
|
||||
- Configure [taplo](https://github.com/tamasfe/taplo) as the LSP server
|
||||
- Install [lsp-mode](https://github.com/emacs-lsp/lsp-mode) and [toml-mode](https://github.com/dryman/toml-mode.el)
|
||||
- Configure [taplo](https://github.com/tamasfe/taplo) as the LSP server
|
||||
|
||||
### Specifying config on the command-line
|
||||
|
||||
|
|
|
|||
|
|
@ -374,12 +374,12 @@ they are needed.
|
|||
Here are some of the commands you may find yourself using frequently during
|
||||
development:
|
||||
|
||||
* `mise test`: Runs all tests.
|
||||
* `mise test <string>`: Runs tests that contain a specific string. For
|
||||
example, `mise test squash` would run tests with "squash" in their name.
|
||||
* `mise build`: Compiles `jj`.
|
||||
* `mise build:release`: Compiles `jj` in release mode.
|
||||
* `mise build:docs`: Builds the documentation for `jj`.
|
||||
* `mise test`: Runs all tests.
|
||||
* `mise test <string>`: Runs tests that contain a specific string. For
|
||||
example, `mise test squash` would run tests with "squash" in their name.
|
||||
* `mise build`: Compiles `jj`.
|
||||
* `mise build:release`: Compiles `jj` in release mode.
|
||||
* `mise build:docs`: Builds the documentation for `jj`.
|
||||
|
||||
For a complete list of all available tasks, you can run `mise tasks` or review
|
||||
the configuration file at `.config/mise.toml`.
|
||||
|
|
|
|||
|
|
@ -244,10 +244,10 @@ K add foo
|
|||
|
||||
Assuming the new files are different in each commit, we get the following trees.
|
||||
Notation:
|
||||
* `id`is the hash of the contents (the `FileId`)
|
||||
* The `2:bar->1:foo` means that copy ID 2 (i.e. hash of the `CopyHistory`
|
||||
struct) has file `bar`, which was copied from copy ID `1`, where it was
|
||||
called `foo`.
|
||||
* `id`is the hash of the contents (the `FileId`)
|
||||
* The `2:bar->1:foo` means that copy ID 2 (i.e. hash of the `CopyHistory`
|
||||
struct) has file `bar`, which was copied from copy ID `1`, where it was
|
||||
called `foo`.
|
||||
```console
|
||||
Commit K:
|
||||
name: foo, id: K, copy_id: 1:foo
|
||||
|
|
|
|||
|
|
@ -127,11 +127,11 @@ proposal.
|
|||
publicly visible at a later time.
|
||||
* Voting is open for at least 1 week, but may be open as long as 2 weeks when
|
||||
appropriate. After that deadline, the GitHub poll will be locked.
|
||||
* The deadline must be announced at the beginning of the voting period -
|
||||
once voting has begun, the deadline cannot change.
|
||||
* The working group may set the voting period longer to encompass two
|
||||
weekends (for more participation around day jobs), for less urgent or more
|
||||
complex proposals, or to account for holidays during the voting period.
|
||||
* The deadline must be announced at the beginning of the voting period -
|
||||
once voting has begun, the deadline cannot change.
|
||||
* The working group may set the voting period longer to encompass two
|
||||
weekends (for more participation around day jobs), for less urgent or more
|
||||
complex proposals, or to account for holidays during the voting period.
|
||||
* Participants can vote in favor or against.
|
||||
* "Participants" means the group of community members as enumerated at the
|
||||
beginning of this document.
|
||||
|
|
|
|||
|
|
@ -109,7 +109,6 @@ markdown_extensions:
|
|||
slugify: !!python/object/apply:pymdownx.slugs.slugify
|
||||
kwds:
|
||||
case: lower
|
||||
- sane_lists
|
||||
- toc:
|
||||
permalink: true
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue