Skip to content

Move and update Get started section #871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 44 commits into from
Dec 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
016efb4
Move and rename Community Cloud quickstart
sfc-gh-dmatthews Oct 31, 2023
22b4db0
Add installation quickstarts
sfc-gh-dmatthews Oct 31, 2023
4ba8ad3
Move installation to use-python-environments
sfc-gh-dmatthews Oct 31, 2023
cbcc759
Update venv+pip installation
sfc-gh-dmatthews Oct 31, 2023
89ba165
Update installation summary page.
sfc-gh-dmatthews Oct 31, 2023
d9d7e40
Clarification
sfc-gh-dmatthews Oct 31, 2023
79212f5
Small edits from proofreading
sfc-gh-dmatthews Oct 31, 2023
d18fbb7
Typos
sfc-gh-dmatthews Oct 31, 2023
0425041
Move get-started files
sfc-gh-dmatthews Oct 31, 2023
5af831a
Add red category and tiles
sfc-gh-dmatthews Nov 1, 2023
763233c
Make Get started it's own category
sfc-gh-dmatthews Nov 1, 2023
12e5fe7
Update _redirects
sfc-gh-dmatthews Nov 1, 2023
ccbccee
Move create-an-app
sfc-gh-dmatthews Nov 1, 2023
f0746cf
Test /library redirect
sfc-gh-dmatthews Nov 1, 2023
07d8c98
Revert "Test /library redirect"
sfc-gh-dmatthews Nov 1, 2023
8125d1d
Update tiles on docs homepage
sfc-gh-dmatthews Nov 2, 2023
caf0824
Update installation TLDR
sfc-gh-dmatthews Nov 2, 2023
1dd6926
Update installation page titles
sfc-gh-dmatthews Nov 2, 2023
aa01074
Rename installation md files
sfc-gh-dmatthews Nov 2, 2023
6591789
Move and rename files
sfc-gh-dmatthews Nov 16, 2023
8f15aac
Regroup and expand main concepts
sfc-gh-dmatthews Nov 17, 2023
e6ef442
_redirects merge conflict
sfc-gh-dmatthews Nov 17, 2023
907387a
Merge branch 'main' into ia/get-started
sfc-gh-dmatthews Nov 17, 2023
4fc3555
Update Main concepts category page
sfc-gh-dmatthews Nov 17, 2023
9209867
Move and rename files
sfc-gh-dmatthews Nov 17, 2023
a2ac024
Merge branch 'ia/get-started' of https://github.com/streamlit/docs in…
sfc-gh-dmatthews Nov 17, 2023
9b0b566
Design tweaks to reduce severity of red
sfc-gh-dmatthews Nov 17, 2023
5c0e0f8
TEMP: Declare prev/next pages to skip dividers
sfc-gh-dmatthews Nov 17, 2023
14162dd
Link and redirect updates with review edits
sfc-gh-dmatthews Nov 18, 2023
f1b035c
Merge branch 'main' into ia/get-started
sfc-gh-dmatthews Nov 30, 2023
40a7e81
Update installation section
sfc-gh-dmatthews Nov 30, 2023
eff163c
Restore original cloud quickstart
sfc-gh-dmatthews Dec 11, 2023
3d36b06
Rename and reorder Get started
sfc-gh-dmatthews Dec 14, 2023
f5dd183
GitHub Codespaces intro rework
sfc-gh-dmatthews Dec 14, 2023
e5990c3
Merge branch 'main' into ia/get-started
sfc-gh-dmatthews Dec 21, 2023
0d9ce55
Remove menu dividers in /get-started/fundamentals
sfc-gh-dmatthews Dec 21, 2023
e0b5441
Move and rename files
sfc-gh-dmatthews Dec 21, 2023
aac3408
Move get started tutorials into separate category
sfc-gh-dmatthews Dec 21, 2023
1201e42
Simplify Installation category page
sfc-gh-dmatthews Dec 22, 2023
1aa0e10
Fix Div import/export error
sfc-gh-dmatthews Dec 22, 2023
67f165e
Improve colors, as well as the infra used for setting colors. (#902)
sfc-gh-tteixeira Dec 22, 2023
2da68f1
Fix bug I introduced in my last commits. (#903)
sfc-gh-tteixeira Dec 22, 2023
9ae52d9
Changed some text & layout in "getting started", "cli", and "anaconda…
sfc-gh-tteixeira Dec 23, 2023
6533748
Capitalization, proper names, and small edit
sfc-gh-dmatthews Dec 23, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ We support syntax highlighting for Python, Bash, TOML, SQL, and JSX.
Use standard Markdown to link to other pages in the docs. E.g. Add an inline link to the "Create an app" page by including the slug defined in the front matter of the "Create an app" `.md` file:

```markdown
Learn how to [Create an app](/library/get-started/create-an-app).
Learn how to [Create an app](/get-started/tutorials/create-an-app).
```

**Add images:**
Expand Down Expand Up @@ -242,13 +242,13 @@ However, a user has to know the URL to visit the page. The page is therefore _re

How do you make the page you created appear in the Menu? Edit the special markdown file `content/menu.md`. All it has is front matter in YAML.

Suppose you have created an "Installation" page that is available at `docs.streamlit.io/library/get-started/installation`. You want to it to appear in the Menu within the "Streamlit Library" section, nested under the "Get Started" page.
Suppose you have created an "Quickstart" page that is available at `docs.streamlit.io/get-started/installation/quickstart`. You want to it to appear in the Menu within the "Get started" section, nested under the "Installation" page.

To do so, find the lines that define the `category`, `url` and `visible` properties for "Get Started" in `menu.md` and add three new lines below it, containing:

```YAML
- category: Streamlit Library / Get Started / Installation
url: /library/get-started/installation
- category: Get Started / Installation / Quickstart
url: /get-started/installation/quickstart
visible: true
```

Expand Down
46 changes: 28 additions & 18 deletions components/blocks/iconHeader.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,44 @@ const IconHeader = ({ icon, rotate, title, background, color }) => {
return (
<section className={classNames(styles.Container)}>
<i
className={classNames(
styles.Icon,
background === "violet-70"
? styles.VioletBackground
: background === "l-blue-70"
? styles.LightBlueBackground
: styles.OrangeBackground
)}
className={classNames(styles.Icon, BG_CLASS[background])}
style={{
transform: `rotate(${rotate}deg)`,
}}
>
{icon}
</i>
<h4
className={classNames(
styles.Title,
background === "violet-70"
? styles.VioletText
: background === "l-blue-70"
? styles.LightBlueText
: styles.OrangeText
)}
>
<h4 className={classNames(styles.Title, FG_CLASS[background])}>
{title}
</h4>
</section>
);
};

const BG_CLASS = {
"red-70": styles.RedBackground,
"orange-70": styles.OrangeBackground,
"yellow-70": styles.YellowBackground,
"green-70": styles.GreenBackground,
"acqua-70": styles.AcquaBackground,
"lightBlue-70": styles.LightBlueBackground,
"darkBlue-70": styles.DarkBlueBackground,
"indigo-70": styles.IndigoBackground,
"gray-70": styles.GrayBackground,
unset: styles.TransparentBackground,
};

const FG_CLASS = {
"red-70": styles.RedForeground,
"orange-70": styles.OrangeForeground,
"yellow-70": styles.YellowForeground,
"green-70": styles.GreenForeground,
"acqua-70": styles.AcquaForeground,
"lightBlue-70": styles.LightBlueForeground,
"darkBlue-70": styles.DarkBlueForeground,
"indigo-70": styles.IndigoForeground,
"gray-70": styles.GrayForeground,
unset: styles.TransparentForeground,
};

export default IconHeader;
54 changes: 47 additions & 7 deletions components/blocks/iconHeader.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,70 @@
}

/* Color modifiers */
.VioletBackground {
@apply bg-indigo-70;
.RedBackground {
@apply bg-red-70;
}

.OrangeBackground {
@apply bg-orange-70;
}

.YellowBackground {
@apply bg-yellow-70;
}

.GreenBackground {
@apply bg-green-70;
}

.AcquaBackground {
@apply bg-acqua-70;
}

.LightBlueBackground {
@apply bg-lightBlue-70;
}

.VioletText {
@apply text-indigo-70 !important;
.DarkBlueBackground {
@apply bg-darkBlue-70;
}

.IndigoBackground {
@apply bg-indigo-70;
}

.RedForeground {
@apply text-red-70 !important;
}

.OrangeText {
.OrangeForeground {
@apply text-orange-70 !important;
}

.LightBlueText {
.YellowForeground {
@apply text-yellow-70 !important;
}

.GreenForeground {
@apply text-green-70 !important;
}

.AcquaForeground {
@apply text-acqua-70 !important;
}

.LightBlueForeground {
@apply text-lightBlue-70 !important;
}

:global(.dark) .VioletText {
.DarkBlueForeground {
@apply text-darkBlue-70 !important;
}

.IndigoForeground {
@apply text-indigo-70 !important;
}

:global(.dark) .IndigoText {
@apply text-white !important;
}
40 changes: 28 additions & 12 deletions components/blocks/inlineCallout.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,8 @@ import classNames from "classnames";
import styles from "./inlineCallout.module.css";

const InlineCallout = ({ children, icon, color, bold, href }) => {
const backgroundColor =
color === "violet-70"
? styles.LibraryBackground
: color === "l-blue-70"
? styles.CloudBackground
: styles.KBBackground;
const textColor =
color === "violet-70"
? styles.LibraryText
: color === "l-blue-70"
? styles.CloudText
: styles.KBText;
const backgroundColor = BG_CLASS[color];
const textColor = FG_CLASS[color];
return (
<section className={styles.Container}>
<Link
Expand Down Expand Up @@ -43,4 +33,30 @@ const InlineCallout = ({ children, icon, color, bold, href }) => {
);
};

const BG_CLASS = {
"red-70": styles.RedBackground,
"orange-70": styles.OrangeBackground,
"yellow-70": styles.YellowBackground,
"green-70": styles.GreenBackground,
"acqua-70": styles.AcquaBackground,
"lightBlue-70": styles.LightBlueBackground,
"darkBlue-70": styles.DarkBlueBackground,
"indigo-70": styles.IndigoBackground,
"gray-70": styles.GrayBackground,
unset: styles.TransparentBackground,
};

const FG_CLASS = {
"red-70": styles.RedForeground,
"orange-70": styles.OrangeForeground,
"yellow-70": styles.YellowForeground,
"green-70": styles.GreenForeground,
"acqua-70": styles.AcquaForeground,
"lightBlue-70": styles.LightBlueForeground,
"darkBlue-70": styles.DarkBlueForeground,
"indigo-70": styles.IndigoForeground,
"gray-70": styles.GrayForeground,
unset: styles.TransparentForeground,
};

export default InlineCallout;
66 changes: 55 additions & 11 deletions components/blocks/inlineCallout.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -29,26 +29,70 @@
}

/* Colors for each category */
.LibraryBackground {
@apply bg-indigo-70;
.RedBackground {
@apply bg-red-70;
}

.OrangeBackground {
@apply bg-orange-70;
}

.CloudBackground {
.YellowBackground {
@apply bg-yellow-70;
}

.GreenBackground {
@apply bg-green-70;
}

.AcquaBackground {
@apply bg-acqua-70;
}

.LightBlueBackground {
@apply bg-lightBlue-70;
}

.KBBackground {
@apply bg-orange-70;
.DarkBlueBackground {
@apply bg-darkBlue-70;
}

.IndigoBackground {
@apply bg-indigo-70;
}

.RedForeground {
@apply text-red-70;
}

.OrangeForeground {
@apply text-orange-70;
}

.YellowForeground {
@apply text-yellow-70;
}

.GreenForeground {
@apply text-green-70;
}

.AcquaForeground {
@apply text-acqua-70;
}

.LightBlueForeground {
@apply text-lightBlue-70;
}

.LibraryText {
@apply text-indigo-70 !important;
.DarkBlueForeground {
@apply text-darkBlue-70;
}

.CloudText {
@apply text-lightBlue-70 !important;
.IndigoForeground {
@apply text-indigo-70;
}

.KBText {
@apply text-orange-70 !important;
:global(.dark) .GrayText {
@apply text-gray-20 !important;
}
2 changes: 1 addition & 1 deletion components/blocks/note.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const Note = ({ children }) => {
icon="push_pin"
rotate="45"
title="Note"
background="l-blue-70"
background="lightBlue-70"
color="white"
/>
{children}
Expand Down
22 changes: 14 additions & 8 deletions components/blocks/tile.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,7 @@ const Tile = ({
);
}

const backgroundColor =
background === "orange-70"
? styles.OrangeBackground
: background === "violet-70"
? styles.VioletBackground
: background === "unset"
? styles.TransparentBackground
: styles.BlueBackground;
const backgroundColor = BG_CLASS[background];

return (
<div
Expand All @@ -84,4 +77,17 @@ const Tile = ({
);
};

const BG_CLASS = {
"red-70": styles.RedBackground,
"orange-70": styles.OrangeBackground,
"yellow-70": styles.YellowBackground,
"green-70": styles.GreenBackground,
"acqua-70": styles.AcquaBackground,
"lightBlue-70": styles.LightBlueBackground,
"darkBlue-70": styles.DarkBlueBackground,
"indigo-70": styles.IndigoBackground,
"gray-70": styles.GrayBackground,
unset: styles.TransparentBackground,
};

export default Tile;
27 changes: 24 additions & 3 deletions components/blocks/tile.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,39 @@
}

/* Color modifiers */

.RedBackground {
@apply bg-red-70;
}

.OrangeBackground {
@apply bg-orange-70;
}

.VioletBackground {
@apply bg-indigo-70;
.YellowBackground {
@apply bg-yellow-70;
}

.BlueBackground {
.GreenBackground {
@apply bg-green-70;
}

.AcquaBackground {
@apply bg-acqua-70;
}

.LightBlueBackground {
@apply bg-lightBlue-70;
}

.DarkBlueBackground {
@apply bg-darkBlue-70;
}

.IndigoBackground {
@apply bg-indigo-70;
}

.TransparentBackground a {
@apply px-0;
}
Expand Down
2 changes: 1 addition & 1 deletion components/blocks/tip.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const Tip = ({ children }) => {
icon="star"
rotate="0"
title="Tip"
background="violet-70"
background="indigo-70"
color="white"
/>
{children}
Expand Down
Loading