Skip to content

Commit 77a1394

Browse files
committed
add example docs
Signed-off-by: Emma Indal <[email protected]>
1 parent 299789f commit 77a1394

File tree

9 files changed

+127
-0
lines changed

9 files changed

+127
-0
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
site/
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
## hello mock docs
2+
3+
!!! test
4+
Testing something
5+
6+
Abbreviations:
7+
Some text about MOCDOC
8+
9+
This is a paragraph.
10+
{: #test_id .test_class }
11+
12+
Apple
13+
: Pomaceous fruit of plants of the genus Malus in
14+
the family Rosaceae.
15+
16+
```javascript
17+
import { test } from 'something';
18+
19+
const addThingToThing = (a, b) a + b;
20+
```
21+
22+
- [abc](#abc)
23+
- [xyz](#xyz)
24+
25+
## abc
26+
27+
This is a b c.
28+
29+
## xyz
30+
31+
This is x y z.
32+
33+
# Emojis
34+
35+
:bulb: :smile:
36+
37+
# Code blocks
38+
39+
```javascript
40+
import { test } from 'something';
41+
42+
const addThingToThing = (a, b) a + b;
43+
```
44+
45+
# Grouped Code blocks
46+
47+
=== "JavaScript"
48+
49+
```javascript
50+
import { test } from 'something';
51+
52+
const addThingToThing = (a, b) a + b;
53+
```
54+
55+
=== "Java"
56+
57+
```java
58+
public void function() {
59+
test();
60+
}
61+
```
62+
63+
```java tab="java"
64+
public void function() {
65+
test();
66+
}
67+
```
68+
69+
```java tab="java 2"
70+
public void function() {
71+
test();
72+
}
73+
```
74+
75+
# MDX truly sane lists
76+
77+
- attributes
78+
79+
- customer
80+
- first_name
81+
- test
82+
- family_name
83+
- email
84+
- person
85+
- first_name
86+
- family_name
87+
- birth_date
88+
- subscription_id
89+
90+
- request
91+
92+
<!-- prettier-ignore -->
93+
*[MOCDOC]: Mock Documentation
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
site_name: docs-test-fixture
2+
site_description: Documentation site test fixture
3+
4+
nav:
5+
- Home: index.md
6+
- SubDocs: '!include ./sub-docs/mkdocs.yml'
7+
- Plugins: '*include ./plugins/*/mkdocs.yml'
8+
9+
plugins:
10+
- techdocs-core
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Plugin A
2+
3+
This is a description of Plugin A. This file exists to prove that glob'd
4+
includes using the `*include` syntax work as expected.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
site_name: Plugin A
2+
site_description: A description of Plugin A
3+
4+
nav:
5+
- Introduction: index.md
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Plugin B
2+
3+
This is a description of Plugin B. This file exists to prove that glob'd
4+
includes using the `*include` syntax work as expected.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
site_name: Plugin B
2+
site_description: A description of Plugin B
3+
4+
nav:
5+
- Introduction: index.md
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
### This is an md file in another docs folder using the [MkDocs Monorepo Plugin](https://github.com/spotify/mkdocs-monorepo-plugin)
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
site_name: subdocs
2+
3+
nav:
4+
- Home 2: 'index.md'

0 commit comments

Comments
 (0)