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-de/main @ c3c1774b #103

Open
wants to merge 75 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
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
094f9d5
feat: migrate to latest VitePress
antfu Feb 2, 2024
a1ae7cf
docs: update docs with latest features
antfu Feb 2, 2024
6733ad9
chore: update
antfu Feb 2, 2024
0a3ecb1
chore: update
antfu Feb 2, 2024
6e98b89
chore: fix css scope
antfu Feb 2, 2024
36a1b5a
chore: fix netlify
antfu Feb 2, 2024
b41368d
chore: update
antfu Feb 2, 2024
79a4d45
chore: fix demo style
antfu Feb 2, 2024
f6bcb59
docs: layout image: add backgroundSize doc (#164)
jdeniau Feb 4, 2024
9bbccbb
docs: updated GitHub actions versions on hosting.md (#163)
george-gca Feb 4, 2024
e52d01f
docs: add 'cards' prop in Tweet component (#166)
ethanniser Feb 6, 2024
2ff4590
fix: components not found (#165) (#167)
KermanX Feb 11, 2024
dbfb016
docs: added info about the possibility to start YouTube video at spec…
BogdanCerovac Feb 11, 2024
178a989
docs: update docs about click animations (#169)
KermanX Feb 15, 2024
5bb36b8
chore: update lint
antfu Feb 15, 2024
081241c
docs: fix typo in syntax.md (#171)
stefanfreitag Feb 18, 2024
7a04557
docs: fix typo in fonts.md (#173)
stone-zeng Feb 20, 2024
c3c1774
docs: update latest features (#174)
KermanX Feb 21, 2024
bb7bf5b
docs(en): merging all conflicts
docschina-bot Feb 21, 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 .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules
dist
.vitepress/@slidev
.vitepress/cache
173 changes: 158 additions & 15 deletions .vitepress/config.js → .vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
// @ts-check
import type { DefaultTheme } from 'vitepress'
import { defineConfig } from 'vitepress'
import { transformerTwoslash } from '@shikijs/vitepress-twoslash'

const Guide = [
const CURRENT_VERSION = '0.48.0-beta.2'

const Guide: DefaultTheme.NavItemWithLink[] = [
{
text: 'Warum Slidev',
link: '/guide/why',
Expand Down Expand Up @@ -55,7 +59,18 @@ const Guide = [
},
]

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

const Theme: (DefaultTheme.NavItemWithLink | DefaultTheme.NavItemChildren)[] = [
{
text: 'Theme benutzen',
link: '/themes/use',
Expand All @@ -70,7 +85,7 @@ const Theme = [
},
]

const Addon = [
const Addon: DefaultTheme.NavItemWithLink[] = [
{
text: 'Addon benutzen',
link: '/addons/use',
Expand All @@ -81,6 +96,7 @@ const Addon = [
},
]

<<<<<<< HEAD:.vitepress/config.js
const Translations = [
{
text: 'Deutsch',
Expand Down Expand Up @@ -128,6 +144,9 @@ const Translations = [
]

const Customizations = [
=======
const Customizations: (DefaultTheme.NavItemWithLink | DefaultTheme.NavItemChildren)[] = [
>>>>>>> c3c1774bdf48295664f5b30d7ba7bfbda5a0f3d2:.vitepress/config.ts
{
text: 'Individualisierung',
link: '/custom/',
Expand All @@ -153,8 +172,13 @@ const Customizations = [
link: '/custom/config-vite',
},
{
<<<<<<< HEAD:.vitepress/config.js
text: 'Windi CSS konfigurieren',
link: '/custom/config-windicss',
=======
text: 'Configure UnoCSS',
link: '/custom/config-unocss',
>>>>>>> c3c1774bdf48295664f5b30d7ba7bfbda5a0f3d2:.vitepress/config.ts
},
{
text: 'Monaco konfigurieren',
Expand Down Expand Up @@ -183,10 +207,10 @@ const Customizations = [
{
text: 'Globale Ebenen',
link: '/custom/global-layers',
}
},
]

const Resources = [
const Resources: DefaultTheme.NavItemWithLink[] = [
{
text: 'Beispielprojekte',
link: '/showcases',
Expand All @@ -201,20 +225,26 @@ const Resources = [
},
]

const slidebars = [
const slidebars: DefaultTheme.SidebarItem[] = [
{
text: 'Guide',
children: Guide,
items: Guide,
},
{
<<<<<<< HEAD:.vitepress/config.js
text: 'Themen',
children: Theme,
=======
text: 'Themes',
items: Theme,
>>>>>>> c3c1774bdf48295664f5b30d7ba7bfbda5a0f3d2:.vitepress/config.ts
},
{
text: 'Addons',
children: Addon,
items: Addon,
},
{
<<<<<<< HEAD:.vitepress/config.js
text: 'Individualisierung',
children: Customizations,
},
Expand All @@ -230,13 +260,18 @@ const slidebars = [
link: '/builtin/layouts',
},
],
=======
text: 'Customizations',
items: Customizations,
},
{
text: 'Built-in',
items: BuiltIn,
>>>>>>> c3c1774bdf48295664f5b30d7ba7bfbda5a0f3d2:.vitepress/config.ts
},
]

/**
* @type {import('vitepress').UserConfig}
*/
module.exports = {
export default defineConfig({
title: 'Slidev',
description: 'Präsentationsfolien für Entwickler',
head: [
Expand All @@ -252,9 +287,27 @@ module.exports = {
['link', { rel: 'preconnect', crossorigin: 'anonymous', href: 'https://fonts.gstatic.com' }],
['link', { href: 'https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@200;400;500&family=Inter:wght@200;400;500;600', rel: 'stylesheet' }],
],
markdown: {
theme: {
light: 'vitesse-light',
dark: 'vitesse-dark',
},
async shikiSetup(shiki) {
await shiki.loadLanguage(
'html',
'xml',
'vue',
'markdown',
)
},
codeTransformers: [
transformerTwoslash(),
],
},
cleanUrls: true,
themeConfig: {
repo: 'slidevjs/docs',
logo: '/logo.svg',
<<<<<<< HEAD:.vitepress/config.js
docsBranch: 'main',
editLinks: true,
editLinkText: 'Schlage Verbesserungen an dieser Seite vor',
Expand All @@ -267,6 +320,15 @@ module.exports = {
// for translations maintainers: change the filter to your locale code (subdomain name)
facetFilters: ['language:de']
}
=======
editLink: {
pattern: 'https://github.com/slidevjs/docs/edit/main/:path',
text: 'Suggest changes to this page',
},

search: {
provider: 'local',
>>>>>>> c3c1774bdf48295664f5b30d7ba7bfbda5a0f3d2:.vitepress/config.ts
},

nav: [
Expand All @@ -275,6 +337,7 @@ module.exports = {
items: Guide,
},
{
<<<<<<< HEAD:.vitepress/config.js
text: 'Thema',
items: Theme,
},
Expand All @@ -285,17 +348,50 @@ module.exports = {
{
text: 'Individualisieren',
items: Customizations,
=======
text: 'Theme',
items: [
...Theme,
{
text: 'Built-in',
items: BuiltIn,
},
],
},
{
text: 'Customize',
items: [
...Customizations,
{
text: 'Addon',
items: Addon,
},
],
>>>>>>> c3c1774bdf48295664f5b30d7ba7bfbda5a0f3d2:.vitepress/config.ts
},
{
text: 'Ressourcen',
items: Resources,
},
{
<<<<<<< HEAD:.vitepress/config.js
text: 'Deutsch',
items: Translations,
=======
text: `v${CURRENT_VERSION}`,
items: [
{ text: 'Release Notes', link: 'https://github.com/slidevjs/slidev/releases' },
],
>>>>>>> c3c1774bdf48295664f5b30d7ba7bfbda5a0f3d2:.vitepress/config.ts
},
],

socialLinks: [
{ icon: 'github', link: 'https://github.com/slidevjs/slidev' },
{ icon: 'twitter', link: 'https://twitter.com/slidevjs' },
{ icon: 'discord', link: 'https://chat.sli.dev' },
],

sidebar: {
'/guide/': slidebars,
'/themes/': slidebars,
Expand All @@ -305,5 +401,52 @@ module.exports = {
'/resources/': slidebars,
'/': slidebars,
},

footer: {
message: 'Released under the MIT License.',
copyright: 'Copyright © 2020 Anthony Fu.',
},
},

locales: {
root: {
label: 'English',
},
zh: {
label: '简体中文',
link: 'https://cn.sli.dev/',
},
fr: {
label: 'Français',
link: 'https://fr.sli.dev/',
},
es: {
label: 'Español',
link: 'https://es.sli.dev/',
},
ru: {
label: 'Русский',
link: 'https://ru.sli.dev/',
},
vn: {
label: 'Việt Nam',
link: 'https://vn.sli.dev/',
},
de: {
label: 'Deutsch',
link: 'https://de.sli.dev/',
},
br: {
label: 'Português (BR)',
link: 'https://br.sli.dev/',
},
el: {
label: 'Ελληνικά',
link: 'https://el.sli.dev/',
},
ja: {
label: '日本語',
link: 'https://ja.sli.dev/',
},
},
}
})
8 changes: 4 additions & 4 deletions .vitepress/scripts/prepare.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
const fs = require('fs-extra')
import { copy, remove } from 'fs-extra'

async function main(){
await fs.remove('.vitepress/@slidev')
await fs.copy('node_modules/@slidev', '.vitepress/@slidev', { dereference: true })
async function main() {
await remove('.vitepress/@slidev')
await copy('node_modules/@slidev', '.vitepress/@slidev', { dereference: true })
}

main()
28 changes: 26 additions & 2 deletions .vitepress/showcases.ts
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ export const showcases: ShowCaseInfo[] = [
name: 'Alexander Eble',
link: 'https://github.com/alexanderdavide',
},
slidesLink: 'https://git-most-wanted.alex-eble.de',
slidesLink: 'https://alexeble.de/talks/git-most-wanted/',
sourceLink: 'https://github.com/alexanderdavide/git-most-wanted',
at: 'Internal Tech Talk',
datetime: '2022-03-11',
Expand All @@ -132,7 +132,7 @@ export const showcases: ShowCaseInfo[] = [
at: 'OpenFunction Tutorial Sharing',
datetime: '2022-05-08',
},
{
{
title: 'Is it Okay to Pursue Functional Programming on Frontend?',
author: {
name: 'Minsu Kim , Changhui Lee',
Expand Down Expand Up @@ -166,6 +166,30 @@ export const showcases: ShowCaseInfo[] = [
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
Loading