You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+12-4Lines changed: 12 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,24 @@ The [OSV-Scanner docs](https://google.github.io/osv-scanner) are hosted on a [Gi
4
4
5
5
## Running docs locally
6
6
7
-
To run docs locally, you will need [Jekyll](https://jekyllrb.com/docs/installation/) on your machine.
7
+
To run the docs locally:
8
8
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].
0 commit comments