Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
S
sp-docs
Manage
Activity
Members
Labels
Plan
Jira
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Model registry
Analyze
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
Perun
Perun ProxyIdP
sp-docs
Commits
4929e34d
Commit
4929e34d
authored
2 years ago
by
Pavel Břoušek
Browse files
Options
Downloads
Patches
Plain Diff
Update README.md
parent
33d5dc98
No related branches found
No related tags found
No related merge requests found
Pipeline
#261407
passed
2 years ago
Stage: test
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+9
-5
9 additions, 5 deletions
README.md
with
9 additions
and
5 deletions
README.md
+
9
−
5
View file @
4929e34d
...
@@ -51,22 +51,26 @@ You can easily convert the Markdown files using various online and offline tools
...
@@ -51,22 +51,26 @@ You can easily convert the Markdown files using various online and offline tools
### mkdocs
### mkdocs
To create a simple website with the documentation, you can use
[
mkdocs
](
https://www.mkdocs.org/user-guide/deploying-your-docs/
)
To create a simple website with the documentation, you can use
[
mkdocs
](
https://www.mkdocs.org/user-guide/deploying-your-docs/
)
.
Run:
To prepare, install
[
Python 3
](
https://www.python.org/downloads/
)
and
[
pip
](
https://pip.pypa.io/en/stable/installation/
)
and run:
```
pip3 install -r requirements.txt
```
Then run a local live server:
```
sh
```
sh
mkdocs serve
mkdocs serve
```
```
to run a local live server or
:
or build the site
:
```
sh
```
sh
mkdocs build
mkdocs build
```
```
to build the site.
You can
[
publish
](
https://www.mkdocs.org/user-guide/deploying-your-docs/
)
to GitHub Pages, Read the Docs or any web server.
You can
[
publish
](
https://www.mkdocs.org/user-guide/deploying-your-docs/
)
to GitHub Pages, Read the Docs or any web server.
You can also upload the result to GitLab Pages by using the
[
.gitlab-ci.yml
](
.gitlab-ci.yml
)
in this repository.
You can also upload the result to GitLab Pages by using the
[
.gitlab-ci.yml
](
.gitlab-ci.yml
)
in this repository.
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