Items like constants or functions have their own page, which only contains their documentation. It's fine, but when you have crates like libc
or stm32
which have A LOT of such items, the impact on the documentation size is huge. So instead of keeping them all in their own page, we would group them by kind in the same module (so a::b
and d::e
would not be in the same page).
This change would impact:
macros.html
)attribute-macros.html
)derive-macros.html
)functions.html
)constants.html
)statics.html
)An anchor would be generated for each item so they can be targeted (and therefore automatically scrolled to) when arriving from external links or from search.
The following items don't have their documentation rendered (I might have forgotten some):
pub extern {crate}
itemsThis is an incoherence in regard to the other items: we show them in the generated documentation, but do not generate a page for them, so if the item has a doc comment, it's ignored currently.
With the first suggestion to group items by kind, I think it would nicely reduce the impact to the generated docs while also removing this incoherence.
or
or
By clicking below, you agree to our terms of service.
New to HackMD? Sign up
Syntax | Example | Reference | |
---|---|---|---|
# Header | Header | 基本排版 | |
- Unordered List |
|
||
1. Ordered List |
|
||
- [ ] Todo List |
|
||
> Blockquote | Blockquote |
||
**Bold font** | Bold font | ||
*Italics font* | Italics font | ||
~~Strikethrough~~ | |||
19^th^ | 19th | ||
H~2~O | H2O | ||
++Inserted text++ | Inserted text | ||
==Marked text== | Marked text | ||
[link text](https:// "title") | Link | ||
 | Image | ||
`Code` | Code |
在筆記中貼入程式碼 | |
```javascript var i = 0; ``` |
|
||
:smile: | ![]() |
Emoji list | |
{%youtube youtube_id %} | Externals | ||
$L^aT_eX$ | LaTeX | ||
:::info This is a alert area. ::: |
This is a alert area. |
On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?
Please give us some advice and help us improve HackMD.
Syncing