mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2025-12-26 21:09:31 +00:00
Improved documentation
This commit is contained in:
parent
1a86dd2487
commit
3a4aa6785d
13 changed files with 227 additions and 21 deletions
|
|
@ -1,20 +1,48 @@
|
|||
title: Part-DB
|
||||
description: A starter template for a Jeykll site using the Just the Docs theme!
|
||||
description: Open source inventory management system for your electronic components.
|
||||
remote_theme: just-the-docs/just-the-docs
|
||||
|
||||
url: "https://part-db.github.io"
|
||||
baseurl: "/Part-DB-symfony" # the subpath of your site, e.g. /blog
|
||||
|
||||
favicon_ico: "/assets/favicon.ico"
|
||||
|
||||
aux_links:
|
||||
Part-DB Repository: https://github.com/Part-DB/Part-DB-symfony
|
||||
|
||||
|
||||
search_enabled: true
|
||||
|
||||
enable_copy_code_button: true
|
||||
heading_anchors: true
|
||||
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
|
||||
# Footer "Edit this page on GitHub" link text
|
||||
gh_edit_link: true # show or hide edit this page link
|
||||
gh_edit_link_text: "Edit this page on GitHub."
|
||||
gh_edit_repository: "https://github.com/Part-DB/Part-DB-symfony" # the github URL for your repo
|
||||
gh_edit_branch: "master" # the branch that your docs is served from
|
||||
gh_edit_source: docs # the source that your files originate from
|
||||
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
|
||||
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
|
||||
|
||||
callouts_level: quiet # or loud
|
||||
callouts:
|
||||
highlight:
|
||||
color: yellow
|
||||
important:
|
||||
title: Important
|
||||
color: blue
|
||||
new:
|
||||
title: New
|
||||
color: green
|
||||
note:
|
||||
title: Note
|
||||
color: purple
|
||||
warning:
|
||||
title: Warning
|
||||
color: red
|
||||
|
||||
plugins:
|
||||
- jekyll-seo-tag
|
||||
Loading…
Add table
Add a link
Reference in a new issue