https://github.com/go-rel/doc

Documentation source code
https://github.com/go-rel/doc

documentation golang hacktoberfest mkdocs orm

Last synced: 9 days ago
JSON representation

Documentation source code

• Host: GitHub
• URL: https://github.com/go-rel/doc
• Owner: go-rel
• License: mit
• Created: 2020-09-28T14:18:18.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-16T13:26:33.000Z (3 months ago)
• Last Synced: 2024-10-29T16:20:41.184Z (17 days ago)
• Topics: documentation, golang, hacktoberfest, mkdocs, orm
• Language: Python
• Homepage:
• Size: 329 KB
• Stars: 0
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# REL Doc

Documentation Source Code for [REL](https://github.com/go-rel/rel).

Website: https://go-rel.github.io

## Development

1. Setup

    ```bash

    pip install \

        'requests' \

        'jinja2==3.0.3' \

        'mkdocs==1.1.2' \

        'mkdocs-material==6.0.0' \

        'mkdocs-material-extensions==1.0.1' \

        'mkdocs-minify-plugin==0.3.0' \

        'mkdocs-macros-plugin==0.4.15' \

        'mkdocs-git-revision-date-plugin==0.3 '\

        'mkdocs-meta-descriptions-plugin===1.0.2'

    go get github.com/Fs02/godoc2md

    ```

2. Run

    ```bash

    mkdocs serve

    ```