mirror of https://github.com/docsifyjs/docsify.git synced 2025-12-08 19:55:52 +00:00

John Hildenbiddle 77d93fae78

Style updates:

- New "core" theme serves as base for all other themes (official and third-party)
- New CSS custom properties for simplified customization of "core" theme
  **Note:** List of available properties will be made available in documentation by embedding soruce CSS in docs after merge. Merge is required because embedded CSS needs to be in `main` branch. For now, see `_vars.css` and `_vars-advanced.css` for details.
- New theme "add-ons" modify core theme properties and/or add custom declarations as needed.
- New Prism.js theme support
- New configurable sidebar toggle design
- New typography defaults to system sans-serif and monospace fonts instead of relying on external web font.
- New "Core Dark" theme addon provide dark theme styles. Can optionally be applied based on operating system's light/dark setting using `@media` attribute on `<link>` element.
- New "Vue" theme addon. Closely replicated popular v4 theme while allowing for v5 enhancements.
- New CSS class names available for adding loading indicators, adding sidebar expand/collapse icons, adding sidebar group styles, clamping sidebar links to a single line with ellipses, and changing the sidebar toggle icon.
- New auto-generated gradient background for cover page (ensure gradient hue is > 50 degree apart, use OKLCH color if supported, randomize grandient angle, reduce brightness in dark mode)
- New button styles (basic, primary, secondary)
- New form element styles (text input, radio, checkbox, )
- New "callouts" (previously "important" and "tip" helpers)
- New default syntax highlighting theme (from [docsify-themeable](https://jhildenbiddle.github.io/docsify-themeable/))
- New auto-generated theme color shade and tint colors
- New auto-generated monochromatic color palette
- New form element styles (fields, legend, text input, text area, checkbox, radio, toggles, and select)
- New "headerless" tables
- New `kbd` styles
- New task list style
- New merged navbar styles (consistent with sidebar nav styles)
- New search plugin styles and keyboard shortcut indicators
- Add ability restore previously focused content element after hiding sidebar
- Add "focus trap" when sidebar is visible on mobile (accessibility)
- Add ability for sidebar links to wrap by default (previous single-line w/ ellipsis display available as CSS class on `<body>` option)
- Add sidebar `page-link`, `group`, and `group-title` CSS classes to sidebar markup.
- Add reduced motion media query to set all animation/transition timings to zero
- Update Google Font imports (use new variable vs older fixed width fonts)
- Update primary/secondary button order on coverpage (primary should be first)
- Fix missing merged navbar when loading at desktop resolution then resizing to mobile
- Fix inverted open/close sidebar visibility state at desktop/mobile resolutions
- Fix overflow setting to prevent clipping of element focus ring
- Fix safe area inset margins on mobile in landscape orientation
- Fix inverted "tip" and "warn" class names
- Fix scroll padding to prevent headers from touching top edge of viewport when scrolled to
- Remove Stylus dependency (now using only PostCSS)
- Remove legacy themes "Buble", "Dark", "Dolphin", and "Pure".

Documentation updates:

- New "UI Kit" page showcasing all elements styled by Docsify
- Update "Quick Start" page template
- Update "Adding pages" page with information on how to properly create sidebar group titles and navbar drop-down menus
- Update "Themes" page with theme and class toggles
- Update "Configuration" page with deprecation warnings for `themeColor` and `topMargin`
- Move "Edit Page" link to footer
- Remove [docsify-themeable](https://jhildenbiddle.github.io/docsify-themeable/) endorsement (currently not compatible with v5 and future is unknown)

Miscellaneous updates:

- New search plugin options: `insertBefore` and `insertAfter`
- Add PostCSS config file
- Update BrowserSync config (disable "ghost" mode)
- Update tests
- Fix Jest + Prettier 3 conflict
- Fix `getAndRemoveDocisfyIgnoreConfig` name type (now `Docisfy` => `Docsify`)
- Fix execution of sidebar-generating code when `hiddenSidebar` is `true`
- Remove `inBrowser` constant (SSR deprecated, so no longer needed)

2024-07-19 15:34:51 +00:00

16 KiB

Raw Blame History

UI Kit

View the markdown source for this page

ui-kit.md

Blockquotes

Cras aliquet nulla quis metus tincidunt, sed placerat enim cursus. Etiam turpis nisl, posuere eu condimentum ut, interdum a risus. Sed non luctus mi. Quisque malesuada risus sit amet tortor aliquet, a posuere ex iaculis. Vivamus ultrices enim dui, eleifend porttitor elit aliquet sed.

- Quote Source

Nested

Level 1

Level 2

Level 3

Buttons

Default

Button

Basic

Button Link Button

Primary

Button Link Button

Secondary

Button Link Button

Callouts

!> Important callout with inline code and additional placeholder text used to force the content to wrap and span multiple lines.

?> Tip callout with inline code and additional placeholder text used to force the content to wrap and span multiple lines.

Code

This is inline code

const add = (num1, num2) => num1 + num2;
const total = add(1, 2);

console.log(total); // 3

<body>
  <p>Hello</p>
</body>

Colors

Theme

Theme Color

Monochromatic

Min

Max

Details

Details (click to open)

Suscipit nemo aut ex suscipit voluptatem laboriosam odio velit. Ipsum eveniet labore sequi non optio vel. Ut culpa ad accusantium est aut harum ipsam voluptatum. Velit eum incidunt non sint. Et molestiae veniam natus autem vel assumenda ut numquam esse. Non nisi id qui vero corrupti quos et.

Details (open by default)

Form Elements

Fieldset

Legend

Label

Input

Checkbox

HTML
CSS
JavaScript

Datalist

Label
Earth Jupiter Mars Mercury Neptune Saturn Uranus Venus

Radio

HTML
CSS
JavaScript

Text

First name

Toggles

Checkbox (multi-select)

HTML
CSS
JavaScript

Radio (single-select)

HTML
CSS
JavaScript

Select

Label
Select a planet... Earth Jupiter Mars Mercury Neptune Saturn Uranus Venus

Textarea

Ipsam totam tempora. Dolorum voluptas error tempore asperiores vitae error laboriosam autem possimus.

Headings

Heading 1 {docsify-ignore}

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse luctus nulla eu ex varius, a varius elit tincidunt. Aenean arcu magna, gravida id purus a, interdum convallis turpis. Aenean id ipsum eu tortor sollicitudin scelerisque in quis elit.

Heading 2 {docsify-ignore}

Vestibulum lobortis laoreet nunc vel vulputate. In et augue non lectus pellentesque molestie et ac justo. Sed sed turpis ut diam gravida sagittis nec at neque. Vivamus id tellus est. Nam ac dignissim mi. Vestibulum nec sem convallis, condimentum augue at, commodo diam.

Heading 3 {docsify-ignore}

Suspendisse sit amet tincidunt nibh, ac interdum velit. Ut orci diam, dignissim at enim sit amet, placerat rutrum magna. Mauris consectetur nibh eget sem feugiat, sit amet congue quam laoreet. Curabitur sed massa metus.

Heading 4 {docsify-ignore}

Donec odio orci, facilisis ac vehicula in, vestibulum ut urna. Ut bibendum ullamcorper risus, ac euismod leo maximus sed. In pulvinar sagittis rutrum. Morbi quis cursus diam. Cras ac laoreet nulla, rhoncus sodales dui.

Heading 5 {docsify-ignore}

Commodo sit veniam nulla cillum labore ullamco aliquip quis. Consequat nulla fugiat consequat ex duis proident. Adipisicing excepteur tempor exercitation ad. Consectetur voluptate Lorem sint elit exercitation ullamco dolor.

Heading 6 {docsify-ignore}

Ipsum ea amet dolore mollit incididunt fugiat nulla laboris est sint voluptate. Ex culpa id amet ipsum amet pariatur ipsum officia sit laborum irure ullamco deserunt. Consequat qui tempor occaecat nostrud proident.

Horizontal Rule

Text before rule.

Text after rule.

IFrame

Example

Images

Inline-style

Reference-style

Light / Dark Theme

Keyboard

Default

⌃⌥⌫

CtrlAltDel

⌃ Control⌥ Alt⌫ Delete

Alternate

⌃⌥⌫

CtrlAltDel

⌃ Control⌥ Alt⌫ Delete

Entities

↑

Arrow Up

↓

Arrow Down

←

Arrow Left

→

Arrow Right

⇪

Caps Lock

⌘

Command

⌃

Control

⌫

Delete

⌦

Delete (Forward)

↘

End

⌤

Enter

⎋

Escape

↖

Home

⇞

Page Up

⇟

Page Down

⌥

Option, Alt

↵

Return

⇧

Shift

␣

Space

⇥

Tab

⇤

Tab + Shift

Links

Inline link

Inline link with title

Reference link by name

Reference link by number

Reference link by self

Lists

Ordered List

Ordered
Ordered
1. Nested
2. Nested (Wrapping): Similique tempora et. Voluptatem consequuntur ut. Rerum minus et sed beatae. Consequatur ut nemo laboriosam quo architecto quia qui. Corrupti aut omnis velit.
Ordered (Wrapping): Error minima modi rem sequi facere voluptatem. Est nihil veritatis doloribus et corporis ipsam. Pariatur eos ipsam qui odit labore est voluptatem enim. Veritatis est qui ut pariatur inventore.

Unordered List

Unordered
Unordered
- Nested
- Nested (Wrapping): Quia consectetur sint vel ut excepturi ipsa voluptatum suscipit hic. Ipsa error qui molestiae harum laboriosam. Rerum non amet illo voluptatem odio pariatur. Ut minus enim.
Unordered (Wrapping): Fugiat qui tempore ratione amet repellendus repudiandae non. Rerum nisi officia enim. Itaque est alias voluptatibus id molestiae accusantium. Cupiditate sequi qui omnis sed facere aliquid quia ut.

Task List

Task
Task
- Subtask
- Subtask
- Subtask
Task (Wrapping): Earum consequuntur itaque numquam sunt error omnis ipsum repudiandae. Est assumenda neque eum quia quisquam laborum beatae autem ad. Fuga fugiat perspiciatis harum quia dignissimos molestiae. Officia quo eveniet tempore modi voluptates consequatur. Eum odio adipisci labore.
- Subtask (Wrapping): Vel possimus eaque laborum. Voluptates qui debitis quaerat atque molestiae quia explicabo doloremque. Reprehenderit perspiciatis a aut impedit temporibus aut quasi quia. Incidunt sed recusandae vitae asperiores sit in.

Output

Et cum fugiat nesciunt voluptates. A atque quos doloribus dolorem quo. Et dignissimos omnis nam. Recusandae voluptatem nam. Tenetur veniam et qui consequatur. Aut sequi atque fuga itaque iusto eum nihil quod iure.

Item
Item
Item

Tables

Alignment

Left Align	Center Align	Right Align	Non‑Breaking Header
A1	A2	A3	A4
B1	B2	B3	B4
C1	C2	C3	C4

Headerless


A1	A2	A3	A4
B1	B2	B3	B4
C1	C2	C3	C4

Scrolling

Header
Dicta in nobis dolor adipisci qui. Accusantium voluptates est dolor laboriosam qui voluptatibus. Veritatis eos aspernatur iusto et dicta quas. Fugit voluptatem dolorum qui quisquam. nihil
Aut praesentium officia aut delectus. Quas atque reprehenderit saepe. Et voluptatibus qui dolores rem facere in dignissimos id aut. Debitis excepturi delectus et quos numquam magnam.
Sed eum atque at laborum aut et repellendus ullam dolor. Cupiditate saepe voluptatibus odit est pariatur qui. Hic sunt nihil optio enim eum laudantium. Repellendus voluptate.

Text Elements

Marked text

Preformatted text

Sample Output

Small Text

This is _subscript

This is ^superscript

Underlined Text

Text Styles

Body text

Bold text

Italic text

Bold and italic text

~~Strikethrough~~

16 KiB Raw Blame History Unescape Escape

UI Kit

Blockquotes

Nested

Buttons

Default

Basic

Primary

Secondary

Callouts

Code

Colors

Theme

Monochromatic

Details

Form Elements

Fieldset

Input

Checkbox

Datalist

Radio

Text

Toggles

Select

Textarea

Headings

Heading 1 {docsify-ignore}

Heading 2 {docsify-ignore}

Heading 3 {docsify-ignore}

Heading 4 {docsify-ignore}

Heading 5 {docsify-ignore}

Heading 6 {docsify-ignore}

Horizontal Rule

IFrame

Images

Inline-style

Reference-style

Light / Dark Theme

Keyboard

Default

Alternate

Entities

Links

Lists

Ordered List

Unordered List

Task List

Output

Tables

Alignment

Headerless

Scrolling

Text Elements

Text Styles

16 KiB

Raw Blame History