Skip to content

Commit cd7cc8a

Browse files
authored
docs: Update the local docs readme so that we can better run the docs locally (#1550)
1 parent d8d794b commit cd7cc8a

File tree

3 files changed

+15
-5
lines changed

3 files changed

+15
-5
lines changed

docs/.bundle/config

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
BUNDLE_PATH: "vendor/bundle"

docs/Gemfile.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ GEM
4343
logger
4444
faraday-net_http (3.3.0)
4545
net-http
46-
ffi (1.17.0-x86_64-linux-gnu)
46+
ffi (1.17.1)
4747
forwardable-extended (2.6.0)
4848
gemoji (4.1.0)
4949
github-pages (232)

docs/README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,24 @@ The [OSV-Scanner docs](https://google.github.io/osv-scanner) are hosted on a [Gi
44

55
## Running docs locally
66

7-
To run docs locally, you will need [Jekyll](https://jekyllrb.com/docs/installation/) on your machine.
7+
To run the docs locally:
88

9-
Here are other [pre-requisites] and instructions for running the [docs locally].
9+
- Install `ruby (>= 3.1.0)`. This should come with `bundler`.
10+
- On Debian, you need to install them separately:
11+
- `ruby`
12+
- `ruby-bundler`
13+
- In this directory:
14+
- `bundle config set --local path 'vendor/bundle'` (you can skip this step if serving from this directory, as the config is already saved in `.bundle/config`)
15+
- `bundle install`
16+
- `bundle exec jekyll serve`
17+
18+
Here's the full documentation on github for running the [docs locally].
1019

11-
[pre-requisites]: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll#prerequisites
1220
[docs locally]: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll#building-your-site-locally
1321

1422
## Formatting docs
1523

16-
We use - [Prettier](https://prettier.io/) to standardize the format of markdown and config files.
24+
We use [Prettier](https://prettier.io/) to standardize the format of markdown and config files.
1725

1826
This requires [node/npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) to be installed.
1927

0 commit comments

Comments
 (0)