Repo for Crossplane documentation.
Go to file
Crossplane 5fa16b07af docs snapshot for crossplane version `master` 2020-10-09 04:10:57 +00:00
.bundle First version of the website. 2018-12-03 22:22:24 -08:00
_data docs snapshot for crossplane version `v0.12` 2020-06-22 15:49:22 +00:00
_includes Fix jump links in docs 2020-10-06 16:57:23 -07:00
_layouts Add Hubspot tracking code across site and docs 2020-09-17 13:51:16 -07:00
_scss Further updates based on new designs 2019-09-18 13:48:08 -07:00
css Add CNCF logo and language to the homepage 2020-07-27 15:41:06 -07:00
docs docs snapshot for crossplane version `master` 2020-10-09 04:10:57 +00:00
fonts Add Avenir-Heavy font. 2018-12-05 10:02:29 -08:00
images Add CNCF logo and language to the homepage 2020-07-27 15:41:06 -07:00
js Fix jump links in docs 2020-10-06 16:57:23 -07: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 Update RubyGem and NPM package deps. 2020-08-10 15:00:18 -07:00
Makefile add incremental local docs option to makefile 2020-10-08 08:14:37 -07:00
OWNERS.md governance: add OWNERS.md to define maintainers of this repo 2020-06-11 19:06:56 -07:00
README.md add incremental local docs option to makefile 2020-10-08 08:14:37 -07:00
_config.yml Fix Edit on Github link for all docs pages 2020-05-23 08:01:31 -05:00
favicon.ico First version of the website. 2018-12-03 22:22:24 -08:00
index.html Fix typo (Gitub > GitHub) 2020-07-29 14:47:37 +00:00
package-lock.json Update RubyGem and NPM package deps. 2020-08-10 15:00:18 -07:00
package.json Update RubyGem and NPM package deps. 2020-08-10 15:00:18 -07: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/crossplane/crossplane/docs is present.

brew install npm

make run_docs_local

To run with --incremental for faster editing:

make run_docs_local_incremental

Note: --incremental is experimental, and sometimes gets stuck: https://jekyllrb.com/docs/configuration/incremental-regeneration/

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