Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TypicalAM/Small-Note-App
Web place to view your notes - powered by Go
https://github.com/TypicalAM/Small-Note-App
gin golang markdown markdown-to-html
Last synced: 2 months ago
JSON representation
Web place to view your notes - powered by Go
- Host: GitHub
- URL: https://github.com/TypicalAM/Small-Note-App
- Owner: TypicalAM
- License: mit
- Created: 2022-09-13T16:01:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-13T16:04:22.000Z (over 2 years ago)
- Last Synced: 2024-04-19T21:05:59.545Z (9 months ago)
- Topics: gin, golang, markdown, markdown-to-html
- Language: Go
- Homepage:
- Size: 36.1 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - TypicalAM/Small-Note-App - Web place to view your notes - powered by Go (Go)
README
# Static Site Generator
👋 Hi! This is a static site generator made in [Gin](https://github.com/gin-gonic/gin). It checks for markdown files in the markdown directory, renders them to HTML and serves them locally. For example the file `markdown/test/example.md` can be viewed in the browser at `example.com/test/example.md`. This app was created for me to try to tidy my university notes (and start finally learning golang and gin).
---
## ✨ Getting Started
### 1. Get the prerequisites
🛠This project requires `golang`, if you're unsure how to set it up I recommend [this page](https://go.dev/doc/install).
### 2. Clone the repository and enter it
```sh
git clone --depth=1 https://github.com/TypicalAM/Static-Site-Generator.git && cd Static-Site-Generator
```
### 3. Run the app!
🌟 To run in a dev environment
```sh
go run .
```
## ✨ Starting the app in a cointainer
If you have a possiblity to run docker containers on your machine, you can also run the dev version of this product directly in the container using the provided `Dockerfile`.
```sh
docker build -t go-docker .
docker run -d -p 3006:3004 go-docker
```
---