Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Site-level configuration for the euv-docs demo home page
(consumed by build.rs when EUV_DOCS_SRC_DIR is unset, e.g.
during cargo clippy / cargo test in the euv-docs crate itself).
site: title: euv-docs description: A documentation site generator powered by euv + euv-ui. logo: '📘' locales:
- prefix: /
Content directory under docs/docs/. Required: the build refuses to
guess a locale's content location, and fails loudly when it is empty
instead of emitting a one-page site.
dir: en lang: en-US label: English title: euv-docs description: A documentation site generator powered by euv + euv-ui. footer: MIT Licensed | Built with euv + euv-ui toc_label: On this page prev_label: Previous next_label: Next navbar:- { text: Home, link: / }
- { text: Guide, link: /guide/ }
- { text: GitHub, link: https://github.com/euv-dev/euv }
euv-docs
A documentation site generator powered by euv + euv-ui (Rust/WASM).
Installation
To use this crate, you can run cmd:
cargo install euv-docs
Footer items
The footer is one row: the locale's footer text, then the items the
site declares. An item is a link with an optional image in front of its
text — a filing notice and the official badge the filing authority
publishes are the canonical use.
Every part of the content comes from the site configuration. The build script reads the items as they are written and invents nothing: no default link, no derived record code, no default badge path.
site:
footer_link: 'https://github.com/euv-dev/euv'
footer_items:
- text: '<the notice>'
link: 'https://…'
icon: '/img/…'
alt: '<the accessible name of the image>'
| Key | Meaning |
|---|---|
footer_link |
Where the footer text points — the license line opens the project's repository |
footer_items |
The items of the row, in display order |
text |
The link text — plain and selectable |
link |
Where the item points |
icon |
An optional local image rendered before the text |
alt |
The accessible name of that image |
The row never wraps: an item that does not fit is cut with an ellipsis instead of being broken across two lines, because a notice cut in half is a number nobody can read or copy.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Contributing
Contributions are welcome! Please open an issue or submit a pull request.
Contact
For any inquiries, please reach out to the author at root@devhub.vip.