Skip to content

Commit c3b7192

Browse files
committed
refactor: adds zensical docs structure
1 parent 4809393 commit c3b7192

6 files changed

Lines changed: 8 additions & 280 deletions

File tree

docs/index.md

Lines changed: 3 additions & 167 deletions
Original file line numberDiff line numberDiff line change
@@ -2,172 +2,8 @@
22
icon: lucide/rocket
33
---
44

5-
# Get started
5+
# Preamble
66

7-
For full documentation visit [zensical.org](https://zensical.org/docs/).
7+
Anomaly uses Render for all their major deployments. Render's neatly fits Anomaly's product development focus. In recent years, the team has turned back to using Django.
88

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!"
9+
Render offers many unique features e.g Workflows.

docs/logfire.md

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

docs/markdown.md

Lines changed: 0 additions & 111 deletions
This file was deleted.

docs/orm.md

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

docs/workflows.md

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

zensical.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ site_description = "A project show tips and tricks to use Render features inside
2222
# The site_author attribute. This is used in the HTML head element.
2323
#
2424
# Read more: https://zensical.org/docs/setup/basics/#site_author
25-
site_author = "<your name here>"
25+
site_author = "Anomaly"
2626

2727
# The site_url is the canonical URL for your site. When building online
2828
# documentation you should set this.
@@ -34,7 +34,7 @@ site_author = "<your name here>"
3434
#
3535
# Read more: https://zensical.org/docs/setup/basics/#copyright
3636
copyright = """
37-
Copyright &copy; 2026 The authors
37+
Copyright &copy; 2026 Anomaly
3838
"""
3939

4040
# Zensical supports both implicit navigation and explicitly defined navigation.

0 commit comments

Comments
 (0)