Skip to content

Commit

Permalink
docs(wiki): make other headings larger
Browse files Browse the repository at this point in the history
  • Loading branch information
saecki committed Jan 13, 2024
1 parent 9a53fa5 commit aa7adc6
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 39 deletions.
26 changes: 13 additions & 13 deletions docgen/templates/documentation.md.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Documentation for `crates.nvim` `<VERSION>`

## Features
# Features
- Complete crate versions and features
- Completion sources for:
- [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
Expand All @@ -26,9 +26,9 @@ Documentation for `crates.nvim` `<VERSION>`
- Navigate the dependency hierarchy
- Indicate if a dependency is optional

## Setup
### Auto completion
#### [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) source
# Setup
## Auto completion
### [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) source

Enable it in the setup.
```lua
Expand Down Expand Up @@ -71,7 +71,7 @@ vim.api.nvim_create_autocmd("BufRead", {
```
</details>

#### [coq.nvim](https://github.com/ms-jpq/coq_nvim) source
### [coq.nvim](https://github.com/ms-jpq/coq_nvim) source
Enable it in the setup, and optionally change the display name.
```lua
require('crates').setup {
Expand All @@ -86,8 +86,8 @@ require('crates').setup {
}
```

### Code actions
#### [null-ls.nvim](https://github.com/jose-elias-alvarez/null-ls.nvim) source
## Code actions
### [null-ls.nvim](https://github.com/jose-elias-alvarez/null-ls.nvim) source
Enable it in the setup, and optionally change the display name.
```lua
local null_ls = require('null-ls')
Expand All @@ -100,11 +100,11 @@ require('crates').setup {
}
```

## Config
# Config

For more information about the type of some fields see [`teal/crates/config.tl`](teal/crates/config.tl).

### Default
## Default

The icons in the default configuration require a patched font.<br>
Any [Nerd Font](https://www.nerdfonts.com/font-downloads) should work.
Expand All @@ -114,7 +114,7 @@ require('crates').setup {
}
```

### Plain text
## Plain text

Replace these fields if you don't have a patched font.
```lua
Expand All @@ -123,12 +123,12 @@ require('crates').setup {
}
```

### Functions
## Functions
```lua
<SHARED:FUNCTIONS>
```

### Key mappings
## Key mappings
Some examples of key mappings.
```lua
<SHARED:keymaps.lua>
Expand All @@ -142,7 +142,7 @@ Some examples of key mappings.
```
</details>

### Show appropriate documentation in `Cargo.toml`
## Show appropriate documentation in `Cargo.toml`
How you might integrate `show_popup` into your `init.vim`.
```vim
<SHARED:show_docs.vim>
Expand Down
26 changes: 13 additions & 13 deletions docgen/wiki/Stable-documentation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Documentation for `crates.nvim` `v0.4.0`

## Features
# Features
- Complete crate versions and features
- Completion sources for:
- [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
Expand All @@ -26,9 +26,9 @@ Documentation for `crates.nvim` `v0.4.0`
- Navigate the dependency hierarchy
- Indicate if a dependency is optional

## Setup
### Auto completion
#### [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) source
# Setup
## Auto completion
### [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) source
Just add it to your list of sources.
```lua
require('cmp').setup {
Expand Down Expand Up @@ -57,7 +57,7 @@ vim.api.nvim_create_autocmd("BufRead", {
```
</details>

#### [coq.nvim](https://github.com/ms-jpq/coq_nvim) source
### [coq.nvim](https://github.com/ms-jpq/coq_nvim) source
Enable it in the setup, and optionally change the display name.
```lua
require('crates').setup {
Expand All @@ -72,8 +72,8 @@ require('crates').setup {
}
```

### Code actions
#### [null-ls.nvim](https://github.com/jose-elias-alvarez/null-ls.nvim) source
## Code actions
### [null-ls.nvim](https://github.com/jose-elias-alvarez/null-ls.nvim) source
Enable it in the setup, and optionally change the display name.
```lua
local null_ls = require('null-ls')
Expand All @@ -86,11 +86,11 @@ require('crates').setup {
}
```

## Config
# Config

For more information about the type of some fields see [`teal/crates/config.tl`](teal/crates/config.tl).

### Default
## Default

The icons in the default configuration require a patched font.<br>
Any [Nerd Font](https://www.nerdfonts.com/font-downloads) should work.
Expand Down Expand Up @@ -242,7 +242,7 @@ require('crates').setup {
}
```

### Plain text
## Plain text

Replace these fields if you don't have a patched font.
```lua
Expand Down Expand Up @@ -291,7 +291,7 @@ require('crates').setup {
}
```

### Functions
## Functions
```lua
-- Setup config and auto commands.
require('crates').setup(cfg: Config)
Expand Down Expand Up @@ -362,7 +362,7 @@ require('crates').focus_popup(line: integer|nil)
require('crates').hide_popup()
```

### Key mappings
## Key mappings
Some examples of key mappings.
```lua
local crates = require('crates')
Expand Down Expand Up @@ -419,7 +419,7 @@ nnoremap <silent> <leader>cC :lua require('crates').open_crates_io()<cr>
```
</details>

### Show appropriate documentation in `Cargo.toml`
## Show appropriate documentation in `Cargo.toml`
How you might integrate `show_popup` into your `init.vim`.
```vim
nnoremap <silent> K :call <SID>show_documentation()<cr>
Expand Down
26 changes: 13 additions & 13 deletions docgen/wiki/Unstable-documentation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Documentation for `crates.nvim` `unstable`

## Features
# Features
- Complete crate versions and features
- Completion sources for:
- [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
Expand All @@ -26,9 +26,9 @@ Documentation for `crates.nvim` `unstable`
- Navigate the dependency hierarchy
- Indicate if a dependency is optional

## Setup
### Auto completion
#### [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) source
# Setup
## Auto completion
### [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) source

Enable it in the setup.
```lua
Expand Down Expand Up @@ -71,7 +71,7 @@ vim.api.nvim_create_autocmd("BufRead", {
```
</details>

#### [coq.nvim](https://github.com/ms-jpq/coq_nvim) source
### [coq.nvim](https://github.com/ms-jpq/coq_nvim) source
Enable it in the setup, and optionally change the display name.
```lua
require('crates').setup {
Expand All @@ -86,8 +86,8 @@ require('crates').setup {
}
```

### Code actions
#### [null-ls.nvim](https://github.com/jose-elias-alvarez/null-ls.nvim) source
## Code actions
### [null-ls.nvim](https://github.com/jose-elias-alvarez/null-ls.nvim) source
Enable it in the setup, and optionally change the display name.
```lua
local null_ls = require('null-ls')
Expand All @@ -100,11 +100,11 @@ require('crates').setup {
}
```

## Config
# Config

For more information about the type of some fields see [`teal/crates/config.tl`](teal/crates/config.tl).

### Default
## Default

The icons in the default configuration require a patched font.<br>
Any [Nerd Font](https://www.nerdfonts.com/font-downloads) should work.
Expand Down Expand Up @@ -269,7 +269,7 @@ require('crates').setup {
}
```

### Plain text
## Plain text

Replace these fields if you don't have a patched font.
```lua
Expand Down Expand Up @@ -318,7 +318,7 @@ require('crates').setup {
}
```

### Functions
## Functions
```lua
-- Setup config and auto commands.
require('crates').setup(cfg: Config)
Expand Down Expand Up @@ -389,7 +389,7 @@ require('crates').focus_popup(line: integer|nil)
require('crates').hide_popup()
```

### Key mappings
## Key mappings
Some examples of key mappings.
```lua
local crates = require('crates')
Expand Down Expand Up @@ -446,7 +446,7 @@ nnoremap <silent> <leader>cC :lua require('crates').open_crates_io()<cr>
```
</details>

### Show appropriate documentation in `Cargo.toml`
## Show appropriate documentation in `Cargo.toml`
How you might integrate `show_popup` into your `init.vim`.
```vim
nnoremap <silent> K :call <SID>show_documentation()<cr>
Expand Down

0 comments on commit aa7adc6

Please sign in to comment.