https://github.com/cuigh/xdoc

A document site based Markdown
https://github.com/cuigh/xdoc

document documentation-tool markdown xdoc

Last synced: 7 months ago
JSON representation

A document site based Markdown

• Host: GitHub
• URL: https://github.com/cuigh/xdoc
• Owner: cuigh
• License: mit
• Created: 2017-12-28T07:15:26.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-10-29T07:54:11.000Z (almost 7 years ago)
• Last Synced: 2025-01-23T10:25:46.115Z (8 months ago)
• Topics: document, documentation-tool, markdown, xdoc
• Language: Go
• Size: 952 KB
• Stars: 0
• Watchers: 0
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# xdoc

A document site based Markdown.

![Snapshot](xdoc.png)

## Usage

### Standalone

```bash

xdoc -d /docs

```

### Docker

First you need create a new docker image base on `cuigh/xdoc`, copy all your documents to `/docs` directory in image. Here is the sample **Dockerfile** file.

```docker

FROM cuigh/xdoc

COPY . /docs/

```

Build the image

```bash

docker build -t docs .

```

Start the container

```bash

docker run -it -p 8000:8000 docs

```

## Customize menus

**xdoc** build document menus according to filename by default, you can customize it by adding a `menu.xml` on document root directory.

```xml

    

        

            

            

        

        

            

            

        

    

```

> NOTE: **xdoc** will look for `README.md` or `index.md` as index page automatically if exists.