Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
synapse
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Maunium
synapse
Commits
d9e9771d
Unverified
Commit
d9e9771d
authored
3 years ago
by
Shay
Committed by
GitHub
3 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Update README.md
parent
ea209370
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/README.md
+4
-2
4 additions, 2 deletions
docs/README.md
with
4 additions
and
2 deletions
docs/README.md
+
4
−
2
View file @
d9e9771d
...
...
@@ -50,8 +50,10 @@ build the documentation with:
mdbook build
```
The rendered contents will be outputted to a new
`book/`
directory at the root of the repository. You can
browse the book by opening
`book/index.html`
in a web browser.
The rendered contents will be outputted to a new
`book/`
directory at the root of the repository. Please note that
index.html is not built by default, it is created by copying over the file
`welcome_and_overview.html`
to
`index.html`
during deployment. Thus, when running
`mdbook serve`
locally the book will initially show a 404 in place of the index
due to the above. Do not be alarmed!
You can also have mdbook host the docs on a local webserver with hot-reload functionality via:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment