From 4ac69bce10fb05d0054f3f5a6ce6cd679996aa45 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Sun, 25 Oct 2026 07:11:54 +0000 Subject: [PATCH] Add README.md --- README.en.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 98 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..dd63d10 --- /dev/null +++ b/README.en.md @@ -0,0 +1,49 @@ +# Zensical + +A modern documentation site built with MkDocs, featuring rich content support and beautiful styling. + +## Features + +- **Getting Started Guide** - Quick introduction to using the documentation +- **Commands Reference** - Complete command documentation +- **Examples** - Practical usage examples +- **Rich Content Support**: + - Admonitions (notes, warnings, tips) + - Details expandable sections + - Syntax-highlighted code blocks + - Content tabs + - Diagrams (Mermaid support) + - Footnotes + - Mathematical formulas (LaTeX) + - Task lists + - Tooltips + +## Documentation + +Full documentation is available in the `docs/` directory: + +- [Getting Started](docs/index.md) - Introduction and quick start +- [Markdown Guide](docs/markdown.md) - Comprehensive Markdown syntax guide + +## Markdown Support + +The project supports extensive Markdown features: + +- All standard Markdown syntax +- Headers (H1-H6) +- Text formatting (bold, italic, strikethrough, etc.) +- Links and images +- Ordered and unordered lists +- Blockquotes +- Code blocks with syntax highlighting +- Tables +- Task lists +- And much more... + +## Configuration + +Project configuration is managed via `zensical.toml`. + +## License + +MIT License \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..dd63d10 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Zensical + +A modern documentation site built with MkDocs, featuring rich content support and beautiful styling. + +## Features + +- **Getting Started Guide** - Quick introduction to using the documentation +- **Commands Reference** - Complete command documentation +- **Examples** - Practical usage examples +- **Rich Content Support**: + - Admonitions (notes, warnings, tips) + - Details expandable sections + - Syntax-highlighted code blocks + - Content tabs + - Diagrams (Mermaid support) + - Footnotes + - Mathematical formulas (LaTeX) + - Task lists + - Tooltips + +## Documentation + +Full documentation is available in the `docs/` directory: + +- [Getting Started](docs/index.md) - Introduction and quick start +- [Markdown Guide](docs/markdown.md) - Comprehensive Markdown syntax guide + +## Markdown Support + +The project supports extensive Markdown features: + +- All standard Markdown syntax +- Headers (H1-H6) +- Text formatting (bold, italic, strikethrough, etc.) +- Links and images +- Ordered and unordered lists +- Blockquotes +- Code blocks with syntax highlighting +- Tables +- Task lists +- And much more... + +## Configuration + +Project configuration is managed via `zensical.toml`. + +## License + +MIT License \ No newline at end of file -- Gitee