Skip to content

Commit 21a18f4

Browse files
committed
docs: add mkdocs
1 parent b0083f5 commit 21a18f4

5 files changed

Lines changed: 99 additions & 1 deletion

File tree

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,4 +191,7 @@ cython_debug/
191191
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
192192
# refer to https://docs.cursor.com/context/ignore-files
193193
.cursorignore
194-
.cursorindexingignore
194+
.cursorindexingignore
195+
196+
# Mkdocs
197+
site/

.readthedocs.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
version: 2
2+
3+
build:
4+
os: "ubuntu-24.04"
5+
tools:
6+
python: "3"
7+
# We recommend using a requirements file for reproducible builds.
8+
# This is just a quick example to get started.
9+
# https://docs.readthedocs.io/page/guides/reproducible-builds.html
10+
jobs:
11+
pre_install:
12+
- pip install mkdocs-material
13+
14+
mkdocs:
15+
configuration: mkdocs.yml

docs/about.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Da membra dictis neve Mavortis obliquum dicere
2+
3+
## Mihi est retro ignarus o ut vera
4+
5+
Lorem markdownum lucis numquam iaculum ubique Aeoliique rursus inque gente
6+
soletur, Baccheaque meo digitis petis labra fecit dixit Phyllei. Metu nomen
7+
quaerebat sequuntur moror contemptoremque macies et ore ad bracchia **vultus
8+
in** corpore fratrum. Exta locus concita flammas. Per domum laevum Amorque vidit
9+
puero hoc famulos hoc *dubio*. Matura dum liquefacta tamen summos paulatimque
10+
senex credulitas iam, est aures iam, aras Hectora nec: angues.
11+
12+
- Suis auro harenis peragit levare est pariter
13+
- Aberat scopulum et equa
14+
- Non digitis
15+
- Euagrus visaque arboribus mites unus cervum
16+
17+
## Fatigatum et vosque agros hoc pleno nec
18+
19+
Aerane in sustinet ossa discriminis obstas omnes, frustra huic. Fuerat sortes
20+
praesagia multis per spesque, [vulneris et
21+
inpono](http://sive.net/dea-egreditur) inquit. Retia esset, primus nacta
22+
totiens; nam oculi inque adversum, et in sum. Est hac ille, limen vellent, iter
23+
equos aerii cum armis pennas perpetuaque ferre qui durare reperto haec.
24+
25+
var voip = gnuLdapGps;
26+
var ajaxOverclocking = golden_backside_snow(nvramCompressionCard.bitRt(wave,
27+
name)) + perlIos;
28+
compiler_hub.ripcordingZifClient /= internic_bar;
29+
var playOptical = gnutella.nas.pebibyteBrouterSequence(gigabyte,
30+
systemSubdirectoryCapacity, ansi);
31+
32+
## Ignes vivere sic nascique patri usum cardine
33+
34+
Solis cum [somno](http://et.com/missusmedicamen.html) est sistunt protinus
35+
Cnosiaci, et crura, et ego, in. [Redimitus aera](http://dicere.io/) ille formae
36+
albet est erroresque, externasque cultores. Sumusve honoratos *nisi*: Booten a
37+
maior imoque Peneide profecto senectae cava.
38+
39+
> Sanguine sanguis, in, Pachyne matrisque angue nodosque, **iam**. Iunctis ranae
40+
> reclusi.
41+
42+
**Hunc undis pulchra**, dicere iure thalamos proles diffudere vigoris animorum.
43+
Non aequora, frementis victor gloria Elpenora indurata et vota; mutata! Nec
44+
terraeque; nocet cum aequora procerum *terras adunco*, vagata pharetram montis.
45+
Sedendo ipsumque? Nec ab at dedit fovebam te quae nactus, ratem gaudia: raptae
46+
currus!
47+
48+
Et mutet saltus *pecudes*, cum vulnere petit Herculis perque: et equinis fatus
49+
super. Superi sua mei [condiderat quidem aurea](http://dederas.io/): est parva
50+
[flectimur studiis](http://www.qua-templum.net/) fertur validi conpellat iuranda
51+
**nubemque crinem sepulcro**. Unum veniunt, est ea fovi segnior *spissi est*,
52+
hoc Mareoticaque pectora tendite vobis sagittifera, cernunt. Contento perpetua
53+
invitaque postquam, ubi et parce, flosque chlamydis flexere senior territa. Ubi
54+
magna Glauci, posita castris amittere silvani nullosque Aestas ultima ad Laiades
55+
saepe densetur petenti arcus, et.

docs/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Welcome to Mklorum
2+
3+
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
4+
5+
## Commands
6+
7+
* `mkdocs new [dir-name]` - Create a new project.
8+
* `mkdocs serve` - Start the live-reloading docs server.
9+
* `mkdocs build` - Build the documentation site.
10+
* `mkdocs -h` - Print help message and exit.
11+
12+
## Project layout
13+
14+
mkdocs.yml # The configuration file.
15+
docs/
16+
index.md # The documentation homepage.
17+
... # Other markdown pages, images and other files.

mkdocs.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
site_name: MkLorum
2+
3+
nav:
4+
- Home: index.md
5+
- About: about.md
6+
7+
theme:
8+
name: material

0 commit comments

Comments
 (0)