Skip to content

Commit 35c2ecc

Browse files
thunderbiscuitthunderbiscuit
committed
docs: add zensical template
1 parent 4ddf3f2 commit 35c2ecc

8 files changed

Lines changed: 730 additions & 0 deletions

File tree

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,6 @@ app.run.xml
2020
release/
2121
.claude/
2222
design/
23+
website/site/
24+
website/.cache/
25+
website/.venv/

‎website/.python-version‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.13

‎website/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Readme
2+
3+
This directory contains the [zensical](https://zensical.org/) website for the Devkit Wallet hosted at [TODO]().

‎website/docs/index.md‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
---
2+
icon: lucide/rocket
3+
---
4+
5+
# Get started
6+
7+
For full documentation visit [zensical.org](https://zensical.org/docs/).
8+
9+
## Commands
10+
11+
* [`zensical new`][new] - Create a new project
12+
* [`zensical serve`][serve] - Start local web server
13+
* [`zensical build`][build] - Build your site
14+
15+
[new]: https://zensical.org/docs/usage/new/
16+
[serve]: https://zensical.org/docs/usage/preview/
17+
[build]: https://zensical.org/docs/usage/build/
18+
19+
## Examples
20+
21+
### Admonitions
22+
23+
> Go to [documentation](https://zensical.org/docs/authoring/admonitions/)
24+
25+
!!! note
26+
27+
This is a **note** admonition. Use it to provide helpful information.
28+
29+
!!! warning
30+
31+
This is a **warning** admonition. Be careful!
32+
33+
### Details
34+
35+
> Go to [documentation](https://zensical.org/docs/authoring/admonitions/#collapsible-blocks)
36+
37+
??? info "Click to expand for more info"
38+
39+
This content is hidden until you click to expand it.
40+
Great for FAQs or long explanations.
41+
42+
## Code Blocks
43+
44+
> Go to [documentation](https://zensical.org/docs/authoring/code-blocks/)
45+
46+
``` python hl_lines="2" title="Code blocks"
47+
def greet(name):
48+
print(f"Hello, {name}!") # (1)!
49+
50+
greet("Python")
51+
```
52+
53+
1. > Go to [documentation](https://zensical.org/docs/authoring/code-blocks/#code-annotations)
54+
55+
Code annotations allow to attach notes to lines of code.
56+
57+
Code can also be highlighted inline: `#!python print("Hello, Python!")`.
58+
59+
## Content tabs
60+
61+
> Go to [documentation](https://zensical.org/docs/authoring/content-tabs/)
62+
63+
=== "Python"
64+
65+
``` python
66+
print("Hello from Python!")
67+
```
68+
69+
=== "Rust"
70+
71+
``` rs
72+
println!("Hello from Rust!");
73+
```
74+
75+
## Diagrams
76+
77+
> Go to [documentation](https://zensical.org/docs/authoring/diagrams/)
78+
79+
``` mermaid
80+
graph LR
81+
A[Start] --> B{Error?};
82+
B -->|Yes| C[Hmm...];
83+
C --> D[Debug];
84+
D --> B;
85+
B ---->|No| E[Yay!];
86+
```
87+
88+
## Footnotes
89+
90+
> Go to [documentation](https://zensical.org/docs/authoring/footnotes/)
91+
92+
Here's a sentence with a footnote.[^1]
93+
94+
Hover it, to see a tooltip.
95+
96+
[^1]: This is the footnote.
97+
98+
99+
## Formatting
100+
101+
> Go to [documentation](https://zensical.org/docs/authoring/formatting/)
102+
103+
- ==This was marked (highlight)==
104+
- ^^This was inserted (underline)^^
105+
- ~~This was deleted (strikethrough)~~
106+
- H~2~O
107+
- A^T^A
108+
- ++ctrl+alt+del++
109+
110+
## Icons, Emojis
111+
112+
> Go to [documentation](https://zensical.org/docs/authoring/icons-emojis/)
113+
114+
* :sparkles: `:sparkles:`
115+
* :rocket: `:rocket:`
116+
* :tada: `:tada:`
117+
* :memo: `:memo:`
118+
* :eyes: `:eyes:`
119+
120+
## Maths
121+
122+
> Go to [documentation](https://zensical.org/docs/authoring/math/)
123+
124+
$$
125+
\cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k}
126+
$$
127+
128+
!!! warning "Needs configuration"
129+
Note that MathJax is included via a `script` tag on this page and is not
130+
configured in the generated default configuration to avoid including it
131+
in a pages that do not need it. See the documentation for details on how
132+
to configure it on all your pages if they are more Maths-heavy than these
133+
simple starter pages.
134+
135+
<script id="MathJax-script" async src="https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js"></script>
136+
<script>
137+
window.MathJax = {
138+
tex: {
139+
inlineMath: [["\\(", "\\)"]],
140+
displayMath: [["\\[", "\\]"]],
141+
processEscapes: true,
142+
processEnvironments: true
143+
},
144+
options: {
145+
ignoreHtmlClass: ".*|",
146+
processHtmlClass: "arithmatex"
147+
}
148+
};
149+
</script>
150+
151+
## Task Lists
152+
153+
> Go to [documentation](https://zensical.org/docs/authoring/lists/#using-task-lists)
154+
155+
* [x] Install Zensical
156+
* [x] Configure `zensical.toml`
157+
* [x] Write amazing documentation
158+
* [ ] Deploy anywhere
159+
160+
## Tooltips
161+
162+
> Go to [documentation](https://zensical.org/docs/authoring/tooltips/)
163+
164+
[Hover me][example]
165+
166+
[example]: https://example.com "I'm a tooltip!"

‎website/docs/markdown.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
icon: simple/markdown
3+
---
4+
5+
# Markdown in 5min
6+
7+
## Headers
8+
```
9+
# H1 Header
10+
## H2 Header
11+
### H3 Header
12+
#### H4 Header
13+
##### H5 Header
14+
###### H6 Header
15+
```
16+
17+
## Text formatting
18+
```
19+
**bold text**
20+
*italic text*
21+
***bold and italic***
22+
~~strikethrough~~
23+
`inline code`
24+
```
25+
26+
## Links and images
27+
```
28+
[Link text](https://example.com)
29+
[Link with title](https://example.com "Hover title")
30+
![Alt text](image.jpg)
31+
![Image with title](image.jpg "Image title")
32+
```
33+
34+
## Lists
35+
```
36+
Unordered:
37+
- Item 1
38+
- Item 2
39+
- Nested item
40+
41+
Ordered:
42+
1. First item
43+
2. Second item
44+
3. Third item
45+
```
46+
47+
## Blockquotes
48+
```
49+
> This is a blockquote
50+
> Multiple lines
51+
>> Nested quote
52+
```
53+
54+
## Code blocks
55+
````
56+
```javascript
57+
function hello() {
58+
console.log("Hello, world!");
59+
}
60+
```
61+
````
62+
63+
## Tables
64+
```
65+
| Header 1 | Header 2 | Header 3 |
66+
|----------|----------|----------|
67+
| Row 1 | Data | Data |
68+
| Row 2 | Data | Data |
69+
```
70+
71+
## Horizontal rule
72+
```
73+
---
74+
or
75+
***
76+
or
77+
___
78+
```
79+
80+
## Task lists
81+
```
82+
- [x] Completed task
83+
- [ ] Incomplete task
84+
- [ ] Another task
85+
```
86+
87+
## Escaping characters
88+
```
89+
Use backslash to escape: \* \_ \# \`
90+
```
91+
92+
## Line breaks
93+
```
94+
End a line with two spaces
95+
to create a line break.
96+
97+
Or use a blank line for a new paragraph.
98+
```

‎website/pyproject.toml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[project]
2+
name = "website"
3+
version = "0.1.0"
4+
description = "Add your description here"
5+
readme = "README.md"
6+
requires-python = ">=3.13"
7+
dependencies = [
8+
"zensical>=0.0.23",
9+
]

0 commit comments

Comments
 (0)