https://github.com/aterdev/easydocs
Easy and fast static docs(blogs) website
https://github.com/aterdev/easydocs
blog docs dotnet website
Last synced: 4 months ago
JSON representation
Easy and fast static docs(blogs) website
- Host: GitHub
- URL: https://github.com/aterdev/easydocs
- Owner: AterDev
- License: mit
- Created: 2024-03-20T02:20:12.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2025-04-14T08:17:16.000Z (about 1 year ago)
- Last Synced: 2025-06-12T08:11:37.632Z (about 1 year ago)
- Topics: blog, docs, dotnet, website
- Language: C#
- Homepage: https://aterdev.github.io/EasyBlog/
- Size: 8.35 MB
- Stars: 12
- Watchers: 1
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EasyDocs
🌐 [English](./README.md) 🌐[中文](./README_cn.md)
Do you want your own tech blog or documentation site? EasyDoc helps you generate pure static blogs and documentation portals that you can deploy anywhere with zero fuss.
The tool works as a command-line utility and will be published on both `npm` and `nuget`.
Demo: [NilTor's Blog](https://dusi.dev/)
> [!NOTE]
> Version V1.0 is no longer maintained—V2 brings richer features and more flexibility.
## 🎖️ Features
Compared with similar tools, EasyDoc offers:
- Minimal configuration to get started quickly
- Unified generation of homepage, blog, documentation, and about pages for a complete personal tech site
- Blog search plus category and archive filtering out of the box
- Support for local image paths inside documentation
- Light and dark themes that follow the system preference while staying mobile-friendly
- Enhanced markdown rendering with TOC, mermaid, nomnoml, Math, plus code highlighting and copy controls
- SEO-friendly meta tags generated automatically
## 🧩 Documentation support
- Render multiple documentation projects within the same site
- Publish multiple versions per documentation
- Deliver documentation in multiple languages
## 🚀 Install the tool
EasyDoc is distributed on `nuget`. Run the following command to install it globally:
```powershell
dotnet tool install -g Ater.EasyDocs
```
After installation, use the `ezdoc` command to operate the tool.
## 🛠️ Use EasyDoc
Pick a repository to store your markdown documents—assume it is located in the folder `MyDocs`. Open a terminal inside `MyDocs` to work in that workspace.
### Configure webinfo.json
Run `ezdoc init` or create `webinfo.json` manually with the structure below:
```json
{
"Name": "Niltor Blog",
"Description": "🗽 for freedom",
"AuthorName": "Ater",
"BaseHref": "/blazor-blog/",
"Domain": "https://aterdev.github.io",
"RepositoryUrl": "https://github.com/AterDev/EasyDocs",
"Branch": "main",
"Icon": "favicon.ico",
"Logo": "logo.png",
"Keywords": "docs,blog,EasyDocs",
"DocInfos": [
{
"Name": "EasyDoc",
"Description": "Official documentation",
"Logo": "logo.png",
"Languages": [
"zh-cn",
"en-us"
],
"Versions": [
"2.0"
]
},
{
"Name": "example",
"Languages": [
"zh-cn"
],
"Versions": [
"1.0"
]
}
]
}
```
The `DocInfos` array tells EasyDoc which documentation projects to render and which languages/versions each project supports. Always keep a trailing `/` on `BaseHref`; set it to `/` when publishing from a root domain with no subfolder.
`RepositoryUrl` and `Branch` drive the “Edit on GitHub” links. `Domain` is used to generate `sitemap.xml` and page canonicals.
### Authoring content
Create a content directory (for example `Content`) containing the following:
- `blogs`: all markdown files here become blog posts
- `docs`: documentation files organized as `docs////...`
- `about.md`: markdown for the about page
The `docs` folder must mirror the structure defined in `DocInfos`. For example:
- docs
- EasyDoc
- zh-cn
- 2.0
- doc1.md
- doc2.md
- en-us
- 2.0
- doc1.md
- example
- zh-cn
- 1.0
- doc.md
### Generate the static site
From the repository root run:
```pwsh
ezdoc build .\Content .\WebApp
```
This command converts every markdown file inside `Content` into a static site under `WebApp`. Preview with `http-server`, then deploy the resulting `WebApp` folder anywhere you host static content.
More details: [Official documentation](https://github.com/AterDev/EasyDocs)