Repo for Crossplane documentation.
Go to file
Jared Watts 06f7ff7847
Merge pull request #25 from prasek/readme-update
live refresh of local edits of crossplane docs
2019-09-18 11:00:10 -07:00
.bundle First version of the website. 2018-12-03 22:22:24 -08:00
_data docs snapshot for crossplane version `v0.2` 2019-04-12 00:10:52 +00:00
_includes Switch blog url to crossplane 2019-01-07 11:11:38 -08:00
_layouts Added preliminary custom 404 page. 2019-01-28 14:27:57 -08:00
_scss Patch gridlex to fix column ordering 2018-12-06 09:11:43 -08:00
css Tweaks to styles to fix various header layout issues 2019-04-15 14:50:24 -04:00
docs docs snapshot for crossplane version `master` 2019-09-18 17:39:38 +00:00
fonts Add Avenir-Heavy font. 2018-12-05 10:02:29 -08:00
images Add twitter card metadata 2018-12-17 15:41:06 -08:00
.gitignore First version of the website. 2018-12-03 22:22:24 -08:00
404.html Added preliminary custom 404 page. 2019-01-28 14:27:57 -08:00
Gemfile Placeholder page 2018-11-20 11:37:43 -08:00
Gemfile.lock Placeholder page 2018-11-20 11:37:43 -08:00
Makefile Add make run_docs_local and update readme 2019-09-16 09:36:50 -07:00
README.md Add make run_docs_local and update readme 2019-09-16 09:36:50 -07:00
_config.yml First version of the website. 2018-12-03 22:22:24 -08:00
favicon.ico First version of the website. 2018-12-03 22:22:24 -08:00
index.html Make urls relative (to support testing on github project pages 2018-12-17 15:44:56 -08:00
package-lock.json First version of the website. 2018-12-03 22:22:24 -08:00
package.json First version of the website. 2018-12-03 22:22:24 -08:00
preprocess.js Add make run_docs_local and update readme 2019-09-16 09:36:50 -07:00

README.md

Crossplane Site

This is the the source for http://crossplane.io. It is rendered using Jekyll by GitHub Pages. Docs from the main crossplane repo are published hear automatically during the main repo CI publish.

To develop locally

This runs locally watching for changes and live reloading.

brew install npm

make run

Open http://localhost:4000 in your browser.

To run locally with local crossplane docs

Ensure $(GOPATH)/src/github.com/crossplaneio/crossplane/docs is present.

brew install npm

make run_docs_local

Open http://localhost:4000 in your browser.