ScStw/documentation
ScStw/documentation
2
0
Fork 0
Code Issues Pull requests Projects Releases Activity

Some updates

Browse source
This commit is contained in:
Dorian Zedler 2021-01-13 22:41:58 +01:00
parent 18e071f85d
commit 2fd405f519
Signed by: dorian
GPG key ID: 989DE36109AFA354
3 changed files with 27 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,3 +1,11 @@
# User documentation # User documentation
User documentation for the Itsblue Speed Climbing Stopwatch. User documentation for the Itsblue Speed Climbing Stopwatch.
# Development
For development, run this in the project root:
```
python -m SimpleHTTPServer
```
The documentation server will run on localhost:8000

21
index.dev.js
View file

@ -1,8 +1,10 @@
new Docute({ new Docute({
// Overrides for all languages target: "app",
router: { router: {
mode: "history", mode: "history",
}, },
// Overrides for all languages
overrides: { overrides: {
"/v0.2/": { "/v0.2/": {
sourcePath: "https://itsblue.dev/ScStw/app/raw/0.1", sourcePath: "https://itsblue.dev/ScStw/app/raw/0.1",
@ -15,8 +17,19 @@ new Docute({
// Define the sidebar // Define the sidebar
sidebar: [ sidebar: [
{ title: "Einleitung", link: "/" }, {
{ title: "Komponenten", link: "/components" }, title: "Einleitung",
children: [
{
title: "Über die ScStw",
link: "/",
},
{
title: "Komponenten",
link: "/components",
},
],
},
{ {
title: "Benutzung", title: "Benutzung",
children: [ children: [
@ -32,7 +45,7 @@ new Docute({
detectSystemDarkTheme: true, detectSystemDarkTheme: true,
darkThemeToggler: true, darkThemeToggler: true,
footer: ` footer: `
<div style="border-top:1px solid var(--border-color);padding-top:30px;margin: 40px 0;color:#999999;font-size: .9rem;"> <div style="border-top:1px solid var(--border-color);padding-top:0px;margin: 0px 0;color:#999999;font-size: .9rem;">
Want more information? Feel free to contact us <a href="https://itsblue.de/contact" target="blank">on our website</a> or at <a href="mailto:contact@itsblue.de">contact@itsblue.de</a>.<br> Want more information? Feel free to contact us <a href="https://itsblue.de/contact" target="blank">on our website</a> or at <a href="mailto:contact@itsblue.de">contact@itsblue.de</a>.<br>
&copy; ${new Date().getFullYear()} Itsblue Development. &copy; ${new Date().getFullYear()} Itsblue Development.
</div> </div>

2
index.html
View file

@ -9,7 +9,7 @@
<link rel="stylesheet" href="https://unpkg.com/docute@4/dist/docute.css" /> <link rel="stylesheet" href="https://unpkg.com/docute@4/dist/docute.css" />
</head> </head>
<body> <body>
<div id="docute"></div> <div id="app"></div>
<script src="https://unpkg.com/docute@4/dist/docute.js"></script> <script src="https://unpkg.com/docute@4/dist/docute.js"></script>
<script src="index.dev.js"></script> <script src="index.dev.js"></script>
</body> </body>