From 49eb75e94b43b3c709ecf2cf8a970e96572c877e Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Wed, 31 Jul 2019 15:24:44 -0700 Subject: readme update --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 4b23bef08..30d2ba52c 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,28 @@ npm i bootstrap-icons --save ``` +## Development + +Clone the repo, install dependencies, and start the Jekyll server locally. + +``` +git clone https://github.com/twbs/icons/ +cd icons +gem install jekyll +npm i +jekyll serve +``` + +Then open http://localhost:4000 in your browser. + +## Publishing + +Docs are published via an npm script that builds the Jekyll site, creates a temporary Git repo, and force pushes that to our `gh-pages` branch. This circumvents issues with GitHub Pages not accepting third party plugins and symlinked directories. + +``` +npm run publish +``` + ## Todos Help wanted if you have ideas how to tackle these! -- cgit v1.2.3