https://github.com/openframeproject/openframe-docs
Documentation for Openframe
https://github.com/openframeproject/openframe-docs
Last synced: 7 months ago
JSON representation
Documentation for Openframe
- Host: GitHub
- URL: https://github.com/openframeproject/openframe-docs
- Owner: OpenframeProject
- License: other
- Created: 2017-01-22T18:21:56.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-10-20T07:15:45.000Z (over 3 years ago)
- Last Synced: 2025-04-06T06:51:16.624Z (10 months ago)
- Language: JavaScript
- Size: 454 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Documentation for Openframe
## How To Contribute
Please help improving these docs. Feel free to [add an issue](https://github.com/OpenframeProject/Openframe-Docs/issues) or [create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
All content is located in `source/index.html.md` and other files in `source/includes/`.
## Development
These docs are based on [Slate](https://github.com/slatedocs/slate). Find more info in the [Slate Wiki](https://github.com/slatedocs/slate/wiki).
Follow this guide to setup a development environment to verify your content updates or improve the website code:
### 0. Prerequisites
Make sure to meet Slate's prerequisites (Ruby, …): https://github.com/slatedocs/slate#prerequisites
### 1. Install
`bundle install`
This installs Slate's dependencies.
### 2. Run development server
`npm start`
This starts a preview web-server (http://localhost:4567). Use this to verify your changes.
More info (https://middlemanapp.com/basics/development-cycle/#middleman-server):
> You can create and edit files in the `source` folder and see the changes reflected on the preview web-server.
> You can stop the preview server from the command-line using `Ctrl + C`.
### 3. Share your changes
Once you're done, commit your work and [create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). A maintainer of the project is going to review and deploy your changes.
## Deploy
`npm run deploy`
This builds the docs, creates a commit with the content of the `build` folder on the `gh-pages` branch. The changes are then (around a minute later) available at https://docs.openframe.io/.
## Build
`npm run build`
This compiles the docs into the `build` directory.