https://github.com/goadmingroup/librarian

A GoAdmin plugin build a document website of markdown
https://github.com/goadmingroup/librarian

Last synced: about 1 month ago
JSON representation

A GoAdmin plugin build a document website of markdown

• Host: GitHub
• URL: https://github.com/goadmingroup/librarian
• Owner: GoAdminGroup
• Created: 2020-04-22T05:16:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-25T01:24:37.000Z (8 months ago)
• Last Synced: 2024-06-20T15:01:12.303Z (6 months ago)
• Language: Go
• Size: 390 MB
• Stars: 8
• Watchers: 3
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Librarian

A GoAdmin plugin which see markdown docs.

[中文文档](./README_CN.md)

![](http://quick.go-admin.cn/docs/librarian_interface_2.png)

## How To

### CLI

- download the [cli](https://github.com/GoAdminGroup/librarian/releases/tag/v0.0.1)

- download the [database](https://github.com/GoAdminGroup/librarian/releases/download/v0.0.1/librarian.db) and put the db in your project folder

- set up nav.yml in your docs folder, here is an [example](https://github.com/GoAdminGroup/librarian/blob/master/cli/docs/nav.yml)

- run:

```bash

./librarian --port=9055 --path=./docs

```

- visit: [http://localhost:9055/docs](http://localhost:9055/docs)

### Use in your GoAdmin app

An [example](https://github.com/GoAdminGroup/librarian/blob/master/example/main.go): 

```

cd example

GO111MODULE=on go run main.go

```

visit: [http://localhost:9033/admin/librarian](http://localhost:9033/admin/librarian)

## TODO

- [ ] Document encryption

- [ ] Edit the new document

- [ ] Real-time monitor nav. Yml