https://github.com/yaml/summit.yaml.io
https://github.com/yaml/summit.yaml.io
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/yaml/summit.yaml.io
- Owner: yaml
- Created: 2017-04-19T18:54:01.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-07T21:57:45.000Z (about 9 years ago)
- Last Synced: 2025-03-20T08:24:25.180Z (about 1 year ago)
- Language: Makefile
- Homepage: http://summit.yaml.io
- Size: 113 KB
- Stars: 4
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.md
Awesome Lists containing this project
README
The YAML Summit Wiki
====================
This is a CogWeb wiki for the YAML Summit, Berlin Germany, May 4-7 2017.
See http://summit.yaml.io
# Using this CogWeb Wiki
* This is a CogWeb wiki. The CogWeb software is included in this repository.
* To enable the CogWeb software, run this command:
`make && source .cogweb/.rc`
* The wiki pages are written in markdown and stored in the `.cog/` directory.
* They have human friendly symlinks in the top level.
* The wiki website is generated by `cogweb` into the `.site/` directory.
* It is then pushed to and served from GitHub Pages.
* Don't commit changes to git by hand.
* Use the `cogweb` CLI described below.
# The `cogweb` Commands
* `cogweb new`
Create a new page. The page should start with a title as the first line:
```# Page Title```
* `cogweb edit `
Edit an existing page. Use this instead of just using your editor. It
validates, links and commits your changes in the appropriate manner.
* `cogweb build`
Build the website from the current pages into the `.site/` directory.
* `cogweb test`
Start a local server to test your changes before pushing.
* `cogweb push`
Publish the wiki. Pushes to the `.site/` directory to the `gh-pages` branch
(GitHub Pages). This does not push your wiki changes to the `master` branch.
Use `git push` to do that.