Skip to content
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

docs(en): merge docs/main into docs-ru/main @ 0ef9dde3 #113

Open
wants to merge 119 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
119 commits
Select commit Hold shift + click to select a range
152e0f6
docs: typo in sidebar (#43)
mathieutu Nov 15, 2021
ad008f0
docs: typos in code (#45)
posva Nov 17, 2021
5d92892
docs: typo (#44)
posva Nov 17, 2021
c393c03
chore: typo (#46)
cheesi Dec 3, 2021
fbc97d8
docs: fix typo (#47)
Deckluhm Dec 8, 2021
a261c23
chore: typo (#48)
tkgroot Dec 20, 2021
06ae275
feat: add TOC documentation (#49)
tonai Jan 17, 2022
ce73d58
fix: broken links (#50)
chengpeiquan Jan 18, 2022
4890d42
Minor notation change (#51)
p1atdev Feb 6, 2022
d99ebc3
feat: add ja trans
antfu Feb 7, 2022
e89a81b
docs: add favicon frontmatter configure (#53)
alexanderdavide Feb 14, 2022
871a293
docs: update shiki URL (#54)
ashramwen Feb 16, 2022
5b4af78
Add slidev-theme-academic (#55)
alexanderdavide Mar 7, 2022
61b06f2
Add showcase Git's Most Wanted (#56)
alexanderdavide Mar 7, 2022
e9cccdb
feat: update install.md to fix the missed docker part (#57)
tangramor Mar 16, 2022
1abac97
Update install.md to fix typos about docker section (#58)
tangramor Mar 16, 2022
b18d6f4
docs: add custom-nav-controls documents (#60)
LarchLiu Mar 22, 2022
d68398a
docs: add mention to --dark option when exporting (#61)
ruyadorno Mar 25, 2022
9fa6829
fix: correct typo in the name of the generated pdf (#62)
twitwi Apr 13, 2022
7308799
Document parameter listClass of Toc (#63)
alexanderdavide Apr 14, 2022
0daa359
feat: add doc for Titles and Link components (#64)
tonai Apr 14, 2022
37797ff
feat: update config doc (#65)
tonai Apr 15, 2022
0305762
docs: update previews of slidev-theme-academic (#66)
alexanderdavide Apr 25, 2022
87e46ef
feat: add doc for CLI commands (#67)
tonai May 19, 2022
017f644
doc: propose a new showcase (#68)
webup May 22, 2022
afa4515
docs: typo with NavControls action description (#69)
lirantal May 24, 2022
1821696
feat: addons doc (#71)
tonai May 25, 2022
1f593ab
docs: fix typos in addons/ (#72)
GeopJr May 27, 2022
2f3c88e
docs: markdown code highlighting for none of the lines (#73)
lirantal Jun 9, 2022
448d7d1
docs: update reference to unplugin-icons (#74)
D3SOX Jun 14, 2022
0d7183d
docs: change some references from http to https (#75)
D3SOX Jun 14, 2022
55faf79
Update navigation.md wording (#77)
CodyBontecou Jun 15, 2022
893d0b6
docs: update custom keybindings (#78)
lirantal Jun 18, 2022
c8121c1
docs: align comments (#80)
yjl9903 Jun 24, 2022
af30fcf
chore: update deps
antfu Jun 30, 2022
6cf71f5
fix: update links
antfu Jun 30, 2022
eca0155
fix: remove work in progress note
antfu Jun 30, 2022
8b430ee
chore: upgrade vitepress
antfu Jul 12, 2022
8c6068a
docs: added description and example usage for auto scroll feature (#83)
wolodev Jul 21, 2022
ea87df4
docs: add previews of slidev-theme-eloc (#85)
zthxxx Jul 27, 2022
e385300
fix: dark mode switch (#86)
leonardssh Jul 31, 2022
1798f9b
Update hosting.md (#88)
pagobls Aug 12, 2022
e9156da
docs: fix exportFilename (#89)
YazanShannak Aug 12, 2022
2b46447
feat: migration message and examples for the new setupShortcuts (#90)
twitwi Sep 12, 2022
f3e4a95
docs: update global-layers.md (#93)
godkun Sep 21, 2022
a9706e0
docs: fix typos and tweak grammar (#94)
Oct 5, 2022
550ff2f
chore: update algolia component
antfu Oct 18, 2022
ecd8bf0
docs(search): correct credentials for docsearch (#95)
Haroenv Oct 18, 2022
7fa7d16
doc: add presenter notes export guide (#96)
lomby92 Oct 25, 2022
26a4550
docs: update for advanced navigation features (#79)
lirantal Oct 25, 2022
37da379
docs: Update showcase list (#92)
alstn2468 Oct 25, 2022
e414b8d
docs: add slidev ppt template with naive-ui (#97)
godkun Nov 4, 2022
041453d
Add slidev-theme-mokkapps (#98)
Mokkapps Nov 4, 2022
eb148aa
fix: disable search box auto open, close #99
antfu Nov 8, 2022
35a71a1
docs: add parser customization (preparser, but also link vite config)…
twitwi Nov 24, 2022
2761858
docs: update parameters in definePreparserSetup (#101)
twitwi Dec 13, 2022
5cffe3b
fix: use bold instead of code tag to avoid breaking chars on mobile (…
jdbruxelles Dec 19, 2022
c32272e
chore(typos): fix typos (#102)
stavares843 Dec 21, 2022
a89202a
docs: update syntax.md (#103)
Mokkapps Jan 10, 2023
2236db4
feat: add LightOrDark component doc (#106)
tonai Jan 20, 2023
9477d41
feat: add presenter mode documentation (#105)
tonai Jan 20, 2023
8d6e5c8
Update showcases.ts (#108)
Mokkapps Jan 23, 2023
2e53e8c
feat: page transition
antfu Jan 29, 2023
fcb11d1
docs: fix broken link in faq (#111)
jChapman Feb 3, 2023
e1c823d
docs: added an example of creating custom Mermaid styles (#110)
estruyf Feb 3, 2023
d6bb78b
docs: Added the unnamed theme (#109)
estruyf Feb 3, 2023
4e268b6
docs: add documentation for export range feature Fix #821 (#104)
neilmispelaar Feb 3, 2023
38e076f
docs: improve slide transition explanation
antfu Feb 3, 2023
8ffa1fd
Update syntax.md: Embedded Styles (#113)
yheuhtozr Feb 5, 2023
dbdc820
docs: fix typo in builtin slide transitions (#114)
matteo-azzolini Feb 6, 2023
9cb6406
docs: update Showcases (#107)
alexanderdavide Feb 7, 2023
7f25ea8
docs(themes): added dracula (#115)
jd-solanki Feb 17, 2023
6c48fa7
feat/export-options
tonai Jan 24, 2023
b66a4ce
feat: add built-in components doc and add buil-in menu (#116)
tonai Feb 24, 2023
c6bd8fa
docs: fix typo in output directory (#118)
enzonotario Mar 6, 2023
46f1104
docs: Added pnpm script (#117)
estruyf Mar 6, 2023
1317cbc
docs: updates for 0.40.5 (#119)
tonai Mar 24, 2023
c2931a4
ci: update checkout and setup-node (#120)
imanmalekian31 Apr 3, 2023
6a80cc0
fix: replace commas with underscores in atomic-css (#122)
matttrice Apr 4, 2023
86744c7
docs: grids-cols to grid-cols (#121)
matttrice Apr 4, 2023
7acc339
docs: add pnpm to install.md instructions (#123)
timozander May 18, 2023
d29625c
docs: align theme docs with types (#124)
bru02 May 21, 2023
19d3ad7
feat: configuring UnoCSS
antfu May 26, 2023
e2d97fb
docs: fix incorrect option name (#125)
kaakaa May 29, 2023
44920cd
docs: support setting startLines for codeblocks slidev (#126)
fr0zn May 31, 2023
281e164
fix: IPA correction (#127)
alephpi Jun 14, 2023
c608c01
fix: FAQ page UnoCSS url (#129)
fakelbst Jul 11, 2023
8f99a82
docs(hosting): Update snippet for GitHub pages workflow (#131)
jd-solanki Jul 16, 2023
cd758d9
docs: improve doc about Link and routeAlias
twitwi Jul 27, 2023
8e6b3c0
docs: Document PDF author and keywords (#132)
marshallfWCCI Aug 6, 2023
333d273
docs: fix motion link (#133)
btea Aug 7, 2023
004c016
docs: mention support for scoped packages (#134)
Plumtree3D Aug 7, 2023
e83fcdc
feat: add built-in layout `two-cols-header` (#135)
btea Aug 11, 2023
a6243d6
fix: the third parameter of userIntervalFn is wrong (#136)
btea Aug 14, 2023
0faff2a
chore: upgrade pnpm
antfu Aug 31, 2023
d45ed05
feat: update docs
antfu Aug 31, 2023
8024ec4
docs: about `$clicks` and `$nav` context shorthand
antfu Aug 31, 2023
f03f026
docs: note about `$clicks` context
antfu Sep 1, 2023
2fe32c4
docs: remove unnecessary colons (#140)
kawamataryo Sep 1, 2023
234e7b1
feat: add `$page` and `$renderContext` context
antfu Sep 3, 2023
6e0af1f
feat: view transitions (#141)
Jannchie Sep 3, 2023
4b8e2bb
docs: add monaco editorOptions (#142)
carlosingles Sep 4, 2023
20eef62
docs(layouts): fix typo (#144)
cerinoligutom Sep 5, 2023
c3ab951
docs: update node version
antfu Sep 5, 2023
11d3475
docs: add LaTex line highlighting (#145)
Sep 7, 2023
0c89704
docs: update hosting guide for GitHub Pages (#146)
george-gca Sep 23, 2023
b67d676
docs: call out required leading slash in base path (#148)
adamdehaven Oct 11, 2023
285da45
docs: update showcase (#149)
zyf722 Oct 24, 2023
cbaf809
docs: `at` option in line highlightning (#150)
TechWatching Nov 9, 2023
32ffb9e
feat: add slidev-theme-frankfurt to themes.ts (#152)
MuTsunTsai Nov 10, 2023
5c3b2e7
docs: yaml block as frontmatter
antfu Nov 16, 2023
4e57682
docs: update hosting.md for gh-pages (#155)
george-gca Nov 21, 2023
e041d9f
docs: explain that Slidev adds custom UnoCSS shortcuts (#157)
Hofer-Julian Nov 23, 2023
a6529b6
docs: support shikiji
antfu Dec 13, 2023
7df7697
feat: Add notice to the custom clicks count when using the at directi…
John98Zakaria Jan 22, 2024
9b64ca2
fix: Remove extra space for props to be parsed correctly (#159)
John98Zakaria Jan 22, 2024
145fc07
docs: fix Shikiji link (#161)
jessarcher Jan 25, 2024
0ef9dde
chore: typos in Highlighters documentation (#162)
laymonage Jan 29, 2024
24d64e7
docs(en): merging all conflicts
docschina-bot Jan 29, 2024
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
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
shamefully-hoist=true
strict-peer-dependencies=false
79 changes: 78 additions & 1 deletion .vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,14 @@ const Guide = [
link: '/guide/presenter-mode',
},
{
<<<<<<< HEAD
<<<<<<< HEAD
text: 'Интеграции редакторов',
=======
text: 'Drawing & Annonations',
=======
text: 'Drawing & Annotations',
>>>>>>> 0ef9dde3b1b07a8fc34763e4b83520b893460024
link: '/guide/drawing',
},
{
Expand Down Expand Up @@ -78,6 +82,17 @@ const Theme = [
},
]

const Addon = [
{
text: 'Use Addon',
link: '/addons/use',
},
{
text: 'Write an Addon',
link: '/addons/write-an-addon',
},
]

const Translations = [
{
text: 'Русский',
Expand Down Expand Up @@ -114,6 +129,10 @@ const Translations = [
text: 'Ελληνικά',
link: 'https://el.sli.dev{{pathname}}',
},
{
text: '日本語',
link: 'https://ja.sli.dev{{pathname}}',
},
]

const Customizations = [
Expand Down Expand Up @@ -142,7 +161,15 @@ const Customizations = [
link: '/custom/config-vite',
},
{
<<<<<<< HEAD
text: 'Конфигурация Windi CSS',
=======
text: 'Configure UnoCSS',
link: '/custom/config-unocss',
},
{
text: 'Configure Windi CSS',
>>>>>>> 0ef9dde3b1b07a8fc34763e4b83520b893460024
link: '/custom/config-windicss',
},
{
Expand All @@ -158,7 +185,15 @@ const Customizations = [
link: '/custom/config-mermaid',
},
{
<<<<<<< HEAD
text: 'Конфигурация горячих клавиш',
=======
text: 'Configure Parser',
link: '/custom/config-parser',
},
{
text: 'Configure Shortcuts',
>>>>>>> 0ef9dde3b1b07a8fc34763e4b83520b893460024
link: '/custom/config-shortcuts',
},
{
Expand All @@ -171,6 +206,17 @@ const Customizations = [
}
]

const BuiltIn = [
{
text: 'Components',
link: '/builtin/components',
},
{
text: 'Layouts',
link: '/builtin/layouts',
},
]

const Resources = [
{
text: 'Примеры',
Expand All @@ -196,6 +242,7 @@ const slidebars = [
children: Theme,
},
{
<<<<<<< HEAD
text: 'Кастомизация',
children: Customizations,
},
Expand All @@ -211,6 +258,18 @@ const slidebars = [
link: '/builtin/layouts',
},
],
=======
text: 'Addons',
children: Addon,
},
{
text: 'Customizations',
children: Customizations,
},
{
text: 'Built-in',
children: BuiltIn,
>>>>>>> 0ef9dde3b1b07a8fc34763e4b83520b893460024
},
]

Expand Down Expand Up @@ -241,7 +300,8 @@ module.exports = {
editLinkText: 'Редактировать страницу',

algolia: {
apiKey: '1a5c5a504139c58f428974c78c55291d',
appId: 'LCBV6MIFS6',
apiKey: '1ff173fe73b20edc962c1c24c0b1c160',
indexName: 'slidev',
searchParameters: {
// for translations maintainers: change the filter to your locale code (subdomain name)
Expand All @@ -259,11 +319,27 @@ module.exports = {
items: Theme,
},
{
<<<<<<< HEAD
text: 'Кастомизация',
items: Customizations,
},
{
text: 'Ресурсы',
=======
text: 'Addon',
items: Addon,
},
{
text: 'Customize',
items: Customizations,
},
{
text: 'Built-in',
items: BuiltIn,
},
{
text: 'Resources',
>>>>>>> 0ef9dde3b1b07a8fc34763e4b83520b893460024
items: Resources,
},
{
Expand All @@ -275,6 +351,7 @@ module.exports = {
sidebar: {
'/guide/': slidebars,
'/themes/': slidebars,
'/addons/': slidebars,
'/custom/': slidebars,
'/builtin/': slidebars,
'/resources/': slidebars,
Expand Down
82 changes: 82 additions & 0 deletions .vitepress/showcases.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,88 @@ export const showcases: ShowCaseInfo[] = [
at: 'Thoughtworks Internal Lunch & Learn',
datetime: '2021-11-12',
},
{
title: 'Git\'s Most Wanted',
cover: 'https://cdn.jsdelivr.net/gh/alexanderdavide/git-most-wanted@assets/slides-export/01.png',
author: {
name: 'Alexander Eble',
link: 'https://github.com/alexanderdavide',
},
slidesLink: 'https://alexeble.de/talks/git-most-wanted/',
sourceLink: 'https://github.com/alexanderdavide/git-most-wanted',
at: 'Internal Tech Talk',
datetime: '2022-03-11',
},
{
title: 'OpenFunction 202',
cover: 'https://s2.loli.net/2022/05/22/4zsCnkQRFoAU1E5.png',
author: {
name: 'Haili Zhang',
link: 'https://github.com/webup',
},
slidesLink: 'https://openfunction-talks.netlify.app/2022/202-node-async/',
sourceLink: 'https://github.com/webup/openfunction-talks/tree/main/202-node-async',
at: 'OpenFunction Tutorial Sharing',
datetime: '2022-05-08',
},
{
title: 'Is it Okay to Pursue Functional Programming on Frontend?',
author: {
name: 'Minsu Kim , Changhui Lee',
},
at: '2022 JSConf Korea',
slidesLink: 'https://moonlit-nougat-422445.netlify.app/1',
sourceLink: 'https://github.com/alstn2468/2022-jsconf-presentation',
cover: 'https://raw.githubusercontent.com/alstn2468/2022-jsconf-presentation/main/public/images/og.png',
datetime: '2022-09-16',
},
{
title: 'Blazing slidev ppt template with naive-ui',
author: {
name: 'godkun',
},
at: 'personal sharing',
slidesLink: 'https://ppt.godkun.top',
sourceLink: 'https://github.com/godkun/ppt-template',
cover: 'https://github.com/godkun/ppt-template/raw/main/public/show.gif',
datetime: '2022-10-24',
},
{
title: 'Building a Polite Popup with Nuxt 3',
author: {
name: 'Michael Hoffmann',
link: 'https://github.com/mokkapps',
},
at: 'Vue.js Nation 2023',
slidesLink: 'https://vuejsnation-2023-talk-polite-popup.netlify.app',
sourceLink: 'https://github.com/Mokkapps/vuejsnation-2023-lightning-talk-polite-popup-nuxt-3-slides',
cover: 'https://raw.githubusercontent.com/Mokkapps/vuejsnation-2023-lightning-talk-polite-popup-nuxt-3-slides/main/screenshots/001.png',
datetime: '2023-01-25',
},
{
title: 'Dev Environment as Code',
cover: 'https://cdn.jsdelivr.net/gh/alexanderdavide/dev-environment-as-code@assets/slides-export/001.png',
author: {
name: 'Alexander Eble',
link: 'https://github.com/alexanderdavide',
},
slidesLink: 'https://alexeble.de/talks/dev-environment-as-code/',
sourceLink: 'https://github.com/alexanderdavide/dev-environment-as-code',
at: 'Internal Tech Talk',
datetime: '2022-12-01',
},
{
title: 'Exploring Social Engineering',
cover: 'https://raw.githubusercontent.com/zyf722/exploring-social-engineering-slides/main/assets/Screenshot_Cover.png',
author: {
name: 'zyf722',
link: 'https://github.com/zyf722',
},
slidesLink: 'https://zyf722.github.io/exploring-social-engineering-slides/',
sourceLink: 'https://github.com/zyf722/exploring-social-engineering-slides',
at: 'Presentation on Social Engineering in Computers in Society class',
datetime: '2023-10-20',
},
// Add yours here!
{
title: 'Yours?',
Expand Down
15 changes: 6 additions & 9 deletions .vitepress/theme/Layout.vue
Original file line number Diff line number Diff line change
Expand Up @@ -50,19 +50,17 @@

<!-- <Debug /> -->

<ClientOnly>
<!-- <ClientOnly>
<WorkingInProgress />
</ClientOnly>
</ClientOnly> -->
</template>

<script setup lang="ts">
import { ref, computed, watch, defineAsyncComponent } from 'vue'
import {
useRoute,
useSiteData,
useSiteDataByRoute,
useData,
} from 'vitepress'
import type { DefaultTheme } from './config'

// components
import NavBar from './components/NavBar.vue'
Expand All @@ -72,8 +70,7 @@ const Home = defineAsyncComponent(() => import('./components/Home.vue'))

// generic state
const route = useRoute()
const siteData = useSiteData<DefaultTheme.Config>()
const siteRouteData = useSiteDataByRoute()
const {site: siteData} = useData()
const theme = computed(() => siteData.value.themeConfig)

const AlgoliaSearchBox = defineAsyncComponent(
Expand All @@ -87,7 +84,7 @@ const enableHome = computed(() => !!route.data.frontmatter.home)

// navbar
const showNavbar = computed(() => {
const { themeConfig } = siteRouteData.value
const { themeConfig } = siteData.value
const { frontmatter } = route.data
if (frontmatter.navbar === false || themeConfig.navbar === false)
return false
Expand All @@ -107,7 +104,7 @@ const openSideBar = ref(false)

const showSidebar = computed(() => {
const { frontmatter } = route.data
const { themeConfig } = siteRouteData.value
const { themeConfig } = siteData.value
return (
!frontmatter.home
&& frontmatter.sidebar !== false
Expand Down
5 changes: 4 additions & 1 deletion .vitepress/theme/NotFound.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@
<div class="theme">
<h1>404</h1>
<blockquote>{{ getMsg() }}</blockquote>
<a :href="$site.base" aria-label="go to home">Take me home.</a>
<a :href="site.base" aria-label="go to home">Take me home.</a>
</div>
</template>

<script setup lang="ts">
import { useData } from 'vitepress';

const {site} = useData()
const msgs = [
'There\'s nothing here.',
'How did we get here?',
Expand Down
Loading