Skip to content

Commit 8df2210

Browse files
Organize into User Guide (#595)
1 parent 5b52532 commit 8df2210

5 files changed

Lines changed: 25 additions & 3 deletions

File tree

doc/config.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ params:
2929
title: Scientific Python Theme
3030
image: logo.svg
3131
buttontext: Get Started
32-
buttonlink: /getstarted/
32+
buttonlink: /user_guide/getstarted/
3333
navbar:
34-
- title: Features
35-
url: /features/
34+
- title: User Guide
35+
url: /user_guide/
3636
- title: Shortcodes
3737
url: /shortcodes/
3838
- title: Examples

doc/content/user_guide/_index.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "User Guide"
3+
shortcutDepth: 2
4+
---
5+
6+
You can configure the behavior, look, and feel of the theme in many ways.
7+
The remaining pages in the user guide cover various ways of doing so.
8+
9+
{{< admonition danger >}}
10+
This theme is still under active development, and we make no promises about the
11+
stability of any specific HTML structure, CSS variables, etc. Make these
12+
customizations at your own risk, and pin versions if you’re worried about
13+
breaking changes!
14+
{{< /admonition >}}
15+
16+
There are a number of options for configuring your site’s look and feel.
17+
18+
- [Get Started](/user_guide/getstarted)
19+
- [Features](/user_guide/features)
20+
- [Web Components](/user_guide/web-components)
File renamed without changes.
File renamed without changes.

doc/content/user_guide/web-components.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,12 @@ practices for native button components such as using the correct [ARIA
9595
attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/button_role).
9696
{{< /admonition >}}
9797

98+
<!-- FIXME
9899
If in your site\'s [custom CSS file](custom-css) you override the [CSS
99100
custom properties](css-variables) `--pst-color-*` (where `*` is one of
100101
the semantic color names, such as `primary`, `danger`), badges and
101102
buttons will automatically use the custom color.
103+
-->
102104

103105
## Cards
104106

0 commit comments

Comments
 (0)