-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
1 parent
a15a156
commit efbf3ce
Showing
1 changed file
with
18 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,22 @@ | ||
|
||
The GCMRC documentation is published using Jekyll and hosting on GitHub Pages. The theme is [Just the Docs](https://just-the-docs.com/). | ||
|
||
# History | ||
|
||
This documentation site was originally written back in 2017 using Hugo and hosted on AWS S3. During the refactor we moved the markdown to Jekyll and CodeSpaces. | ||
|
||
> cd /workspaces/sandbar-analysis-workbench/docs && bundle exec jekyll serve | ||
# Current Configuration | ||
|
||
The easiest way to work with this documentation site is using GitHub CodeSpaces. Go to the repo on GitHub and drop the menu down beside the green "Clone" button and choose "Code Spaces". | ||
|
||
Start the CodeSpace in Visual Studio Code. It should start up and launch a local browser on port 4000 connected to the CodeSpace server. | ||
|
||
Edit and save markdown files as normal. Drag and drop images into Visual Studio Code to add them to the repo. | ||
|
||
Saving files should cause a hot reload of the server. If you need to stop and restart the server (because you changed the `_config.yml` file use the command: | ||
|
||
```bash | ||
cd /workspaces/sandbar-analysis-workbench/docs && bundle exec jekyll serve | ||
``` | ||
|
||
If you need to change the CodeSpace file. Close Visual Studio and use the CodeSpace menu items in GitHub to delete and then restart the CodeSpace. |