Skip to content

Commit e158832

Browse files
committed
add the mkdocs
1 parent 2967290 commit e158832

File tree

129 files changed

+8868
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

129 files changed

+8868
-0
lines changed

docs/api/textpipe.md

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

docs/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Welcome to MkDocs
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: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
site_name: TextPipe
2+
site_url: https://example.com
3+
theme:
4+
name: material
5+
features:
6+
- navigation.tabs
7+
- navigation.top
8+
- navigation.expand
9+
- navigation.sections
10+
- navigation.instant
11+
- navigation.tracking
12+
- navigation.tabs.sticky
13+
- navigation.search.highlight
14+
- navigation.search.suggest
15+
- navigation.search.suggest.auto
16+
- navigation.search.suggest.auto.complete
17+
- navigation.search.suggest.auto.complete.delay: 300ms
18+
19+
plugins:
20+
- mkdocstrings:
21+
handlers:
22+
python:
23+
paths: [.]
24+
nav:
25+
- Home: index.md
26+
# - About: about.md
27+
- API Reference:
28+
- MyModule: api/textpipe.md
29+
# - Guides:
30+
# - Getting Started: guides/getting-started.md
31+
# - Advanced Topics: guides/advanced-topics.md

0 commit comments

Comments
 (0)