https://github.com/rethunk-tech/wiki2go
https://github.com/rethunk-tech/wiki2go
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/rethunk-tech/wiki2go
- Owner: Rethunk-Tech
- License: agpl-3.0
- Created: 2024-06-22T22:07:41.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-16T07:33:50.000Z (almost 2 years ago)
- Last Synced: 2024-07-16T09:58:16.252Z (almost 2 years ago)
- Language: Go
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wiki2go
## Features
- [x] Create a self-contained Wiki from Markdown files.
- [ ] Support for metadata from YAML front matter.
- [x] Support for GitHub-Flavoured-Markdown.
- [x] Serve the Wiki as a static website.
- [ ] Use as a Github Action.
## Quick Start
```bash
# Clone the repository
git clone https://github.com/Rethunk-Tech/wiki2go.git
cd wiki2go
# Build the binary locally
go install ./cmd/wiki2go
# Run the binary
wiki2go --help
```
## Usage
```bash
# Create a new Wiki-based project.
wiki2go new my-wiki
# Open the Wiki's contents in your default editor.
wiki2go edit
# Serve the Wiki. (Open in your default browser.)
wiki2go serve --open
```
## License
This repository's binaries and source code are provided under the:
[GNU Affero General Public License (AGPL)](LICENSE)