Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apex/static
The static site anti-framework – general-purpose library, purpose-built commands for various domains
https://github.com/apex/static
Last synced: 25 days ago
JSON representation
The static site anti-framework – general-purpose library, purpose-built commands for various domains
- Host: GitHub
- URL: https://github.com/apex/static
- Owner: apex
- Created: 2017-08-02T16:51:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-12-09T11:52:43.000Z (about 5 years ago)
- Last Synced: 2024-11-10T20:06:26.996Z (about 1 month ago)
- Language: Go
- Homepage:
- Size: 104 KB
- Stars: 293
- Watchers: 15
- Forks: 18
- Open Issues: 16
-
Metadata Files:
- Readme: Readme.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-starred - apex/static - The static site anti-framework – general-purpose library, purpose-built commands for various domains (others)
README
The goal of this project is to build a common toolkit for building static sites for a variety of domains. Each program is tailored to one domain, such as a blog, documentation site, photo gallery, and so on. For example. Focusing the UX on each domain as necessary makes for a smoother experience, nicer content structuring, while maintaining an overall common feel and usability through the shared library. The shared library or "static stdlib" will also make it easy to write custom static generators to fit your needs.
I think this technique makes much more sense than fighting tools which are designed for blogs, as we all know how to write code, it can sometime save hours to just write a few lines instead of fighting a complex system that tries to do everything. I don't have much time for OSS right now, so it only has what I need, but hopefully long-term it'll turn into something real.
Deploy in a single command to the [Netlify](https://www.netlify.com/) CDN, or to AWS using [Apex Up](https://github.com/apex/up).
## Install
```bash
$ go get github.com/apex/static/cmd/static-docs
```
## Usage
The `static-docs` program generates a documentation website from a directory of markdown files. For example the [Up](https://up.docs.apex.sh/) documentation is generated with:
```
$ static-docs --in docs --out . --title Up --subtitle "Deploy serverless apps in seconds"
```
---
[](https://godoc.org/github.com/apex/static)
