euv-docs 0.32.6

A documentation site generator powered by euv + euv-ui (Rust/WASM).
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

---
# 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 }
---

<center>

## euv-docs

<img src="https://docs.ltpp.vip/img/euv-docs.png" alt="" height="160">

[![](https://img.shields.io/crates/v/euv-docs.svg)](https://crates.io/crates/euv-docs)
[![](https://img.shields.io/crates/d/euv-docs.svg)](https://img.shields.io/crates/d/euv-docs.svg)
[![](https://docs.rs/euv-docs/badge.svg)](https://docs.rs/euv-docs)
[![](https://github.com/euv-dev/euv/workflows/Rust/badge.svg)](https://github.com/euv-dev/euv/actions?query=workflow=Rust)
[![](https://img.shields.io/crates/l/euv-docs.svg)](./LICENSE)

</center>

[Api Docs](https://docs.rs/euv-docs/latest/)

> A documentation site generator powered by euv + euv-ui (Rust/WASM).

## Installation

To use this crate, you can run cmd:

```shell
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.

```yaml
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](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](mailto:root@devhub.vip).