Skip to content

Commit 7868ea9

Browse files
KeyZox71KeyZox71
committed
γ€ŒπŸŽ‰γ€ init: hello world !
1 parent 9eeb7b0 commit 7868ea9

10 files changed

Lines changed: 780 additions & 0 deletions

File tree

β€Ž.envrcβ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
watch_file shell.nix
2+
watch_file treefmt.nix
3+
4+
use flake
5+
unset IN_NIX_SHELL

β€Ž.github/workflows/docs.ymlβ€Ž

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Documentation
2+
on:
3+
push:
4+
branches:
5+
- master
6+
- main
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
jobs:
12+
deploy:
13+
environment:
14+
name: github-pages
15+
url: ${{ steps.deployment.outputs.page_url }}
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/configure-pages@v6
19+
- uses: actions/checkout@v6
20+
- uses: actions/setup-python@v6
21+
with:
22+
python-version: 3.x
23+
- run: pip install zensical
24+
- run: zensical build --clean
25+
- uses: actions/upload-pages-artifact@v5
26+
with:
27+
path: site
28+
- uses: actions/deploy-pages@v5
29+
id: deployment

β€Ž.gitignoreβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# nix shit
2+
.direnv

β€Ždocs/index.mdβ€Ž

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
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" 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+
150+
document$.subscribe(() => {
151+
MathJax.startup.output.clearCache()
152+
MathJax.typesetClear()
153+
MathJax.texReset()
154+
MathJax.typesetPromise()
155+
})
156+
</script>
157+
158+
## Task Lists
159+
160+
> Go to [documentation](https://zensical.org/docs/authoring/lists/#using-task-lists)
161+
162+
* [x] Install Zensical
163+
* [x] Configure `zensical.toml`
164+
* [x] Write amazing documentation
165+
* [ ] Deploy anywhere
166+
167+
## Tooltips
168+
169+
> Go to [documentation](https://zensical.org/docs/authoring/tooltips/)
170+
171+
[Hover me][example]
172+
173+
[example]: https://example.com "I'm a tooltip!"

β€Ždocs/markdown.mdβ€Ž

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

β€Žflake.lockβ€Ž

Lines changed: 62 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
Β (0)