-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4f210ee
commit c1e5988
Showing
1 changed file
with
29 additions
and
14 deletions.
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,25 +1,40 @@ | ||
# ioos-metadata | ||
GitHub Pages for IOOS Metadata Profile with Jekyll Documentation Theme | ||
|
||
See website at https://ioos.github.io/ioos-metadata/ | ||
See website at [https://ioos.github.io/ioos-metadata/](https://ioos.github.io/ioos-atn-data/) | ||
|
||
## Developer Info: Running Locally | ||
## Contributing to the documentation | ||
See [CONTRIBUTING](CONTRIBUTING.md). | ||
|
||
When you clone or pull this repo, make sure to run `git submodule update --init` to update the git submodules. | ||
## Deploying site locally | ||
Requirements: | ||
* bundle | ||
* Jekyll | ||
|
||
To run, use one of the options below. After jekyll has started, go to http://localhost:4000/ioos-metadata/ to view the site. As you update pages in the repo, the changes will be automatically reflected. | ||
See [IOOS How To: Local Development with Jekyll](https://ioos.github.io/ioos-documentation-jekyll-skeleton/howto.html#local-development-with-jekyll). | ||
|
||
### Option 1: run Jekyll directly | ||
|
||
Follow the quickstart instructions at https://jekyllrb.com/docs/ to install jekyll and serve this site. | ||
Clone this repository: | ||
```commandline | ||
git clone https://github.com/ioos/ioos-atn-data.git | ||
``` | ||
Checkout the gh-pages branch: | ||
```commandline | ||
git checkout gh-pages | ||
``` | ||
To build the site, in the `ioos-atn-data/` directory run: | ||
```commandline | ||
bundle exec jekyll serve --config _config.yml --watch --verbose --incremental | ||
``` | ||
This will deploy a website at: http://127.0.0.1:4000/ioos-atn-data/ | ||
|
||
### Option 2: Run Jekyll via Docker | ||
Make edits to the appropriate markdown files in `_docs/`. | ||
|
||
If changing headers and menus, stop the running server by entering `ctrl-c` in the terminal. Then run: | ||
```commandline | ||
bundle exec jekyll clean | ||
``` | ||
docker run \ | ||
-v "$PWD:/srv/jekyll" \ | ||
-p 4000:4000 \ | ||
jekyll/jekyll:3.8 \ | ||
jekyll serve | ||
Then build the site again. | ||
```commandline | ||
bundle exec jekyll serve --config _config.yml --watch --verbose --incremental | ||
``` | ||
|
||
And review at http://127.0.0.1:4000/ioos-atn-data/ |