DocsViewer - A sample project

DocsViewer is a dynamic, high-performance ASP.NET Core web application that serves markdown documentation.

Usage

DocsViewer is designed to be highly compatible with traditional MkDocs conventions, meaning there is zero learning curve for documentation authors.

To use DocsViewer, simply provide your markdown files and configure them using a properdocs.yml file (which behaves exactly like mkdocs.yml). DocsViewer natively supports standard MkDocs configurations like docs_dir, edit_uri, and the nav tree layout.

Just drop your existing MkDocs documentation folder into DocsViewer, and it will automatically render it while supercharging your docs with advanced dynamic features like full-text search, database caching, on-the-fly routing, and AI-powered multi-language translation!

Default user name is admin@default.com and default password is Admin@123456!.

Try

Try a running DocsViewer here.

Run in Ubuntu

The following script will install\update this app on your Ubuntu server. Supports Ubuntu 25.04.

On your Ubuntu server, run the following command:

curl -sL https://github.com/aiursoftweb/docsViewer/raw/master/install.sh | sudo bash

Of course it is suggested that append a custom port number to the command:

curl -sL https://github.com/aiursoftweb/docsViewer/raw/master/install.sh | sudo bash -s 8080

It will install the app as a systemd service, and start it automatically. Binary files will be located at /opt/apps. Service files will be located at /etc/systemd/system.

apt package filesystem layout

When installed via apt install aiursoft-docsViewer, the following paths are created:

Role	Path	apt remove	apt purge
Working directory & binaries	/usr/share/aiursoft-docsViewer/	✓	✓
Config file	/etc/aiursoft-docsViewer/appsettings.json		✓
Runtime data (DB, storage, keys)	/var/lib/aiursoft-docsViewer/
systemd unit	/lib/systemd/system/aiursoft-docsViewer.service	✓	✓

The config file is a dpkg conffile — kept on remove, deleted only on purge. Runtime data under /var/lib/aiursoft-docsViewer/ is user data and intentionally never removed by dpkg.

Run manually

Requirements about how to run

1. Install .NET 10 SDK and Node.js.
2. Execute npm install at wwwroot folder to install the dependencies.
3. Execute dotnet run to run the app.
4. Use your browser to view http://localhost:5000.

Run in Microsoft Visual Studio

1. Open the .sln file in the project path.
2. Press F5 to run the app.

Run in Docker

First, install Docker here.

Then run the following commands in a Linux shell:

image=aiursoft/docsViewer
appName=docsViewer
sudo docker pull $image
sudo docker run -d --name $appName --restart unless-stopped -p 5000:5000 -v /var/www/$appName:/data $image

That will start a web server at http://localhost:5000 and you can test the app.

The docker image has the following context:

Properties	Value
Image	aiursoft/docsViewer
Ports	5000
Binary path	/app
Data path	/data
Config path	/data/appsettings.json

How to contribute

There are many ways to contribute to the project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.

Even if you with push rights on the repository, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean and your workflow cruft out of sight.

We're also interested in your feedback on the future of this project. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.