https://github.com/goby-lang/goby-lang.github.io
https://github.com/goby-lang/goby-lang.github.io
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/goby-lang/goby-lang.github.io
- Owner: goby-lang
- Created: 2018-02-22T08:02:13.000Z (over 7 years ago)
- Default Branch: source
- Last Pushed: 2022-12-07T17:38:06.000Z (over 2 years ago)
- Last Synced: 2024-02-25T00:33:18.394Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://goby-lang.org
- Size: 1.46 MB
- Stars: 1
- Watchers: 6
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Document site for Goby
**This site is powered by [docusaurus](https://docusaurus.io/)**
## Prerequisite
- `yarn`
## Development
1. `cd website`
2. `yarn start`
## About Branch and Publishing
### Branch
Our default source branch is `source` instead of `master`. `master` branch is where
we put the build results (this is how GitHub page works).
So every site development or documentation should base on `source` branch.
### Publish the Site
To publish the site, run the following command:
```
$ cd website
$ GIT_USER= CURRENT_BRANCH=source USE_SSH=true yarn run publish-gh-pages
```
The `GH_USERNAME` should be your github username which should have the permission to push
changes to this repo.
And note that publishing the site has nothing to do with if the changes are committed
or pushed. So please make sure you know what your doing before running the above commands.