From cea5b0bf27adf44ba833f69a51ca90c631beec04 Mon Sep 17 00:00:00 2001 From: Chris McQuaid Date: Sun, 2 Jun 2024 14:00:14 +0100 Subject: [PATCH] docs: typos (#1643) Co-authored-by: Chris McQuaid --- CONTRIBUTING.md | 4 ++-- README.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 873d65db05..918c136e38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,9 +2,9 @@ Excited to hear that you are interested in contributing to this project! Thanks! -## Documentations +## Documentation -Documentations are now moved to [`slidevjs/docs`](https://github.com/slidevjs/docs) repo. +Documentation has now been moved to the [`slidevjs/docs`](https://github.com/slidevjs/docs) repo. ## Setup (in your browser) diff --git a/README.md b/README.md index 29c2dd5643..72f1de7e38 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ Presentation slides for developers 🧑‍💻👩‍💻👨‍ ## Features -- 📝 [**Markdown-based**](https://sli.dev/guide/syntax.html) - use your favorite editors and workflow +- 📝 [**Markdown Based**](https://sli.dev/guide/syntax.html) - use your favorite editors and workflow - 🧑‍💻 [**Developer Friendly**](https://sli.dev/guide/syntax.html#code-blocks) - built-in syntax highlighting, live coding, etc. - 🎨 [**Themable**](https://sli.dev/themes/gallery.html) - theme can be shared and used with npm packages. - 🌈 [**Stylish**](https://sli.dev/guide/syntax.html#embedded-styles) - on-demand utilities via [UnoCSS](https://github.com/unocss/unocss). @@ -67,7 +67,7 @@ Install [Node.js >=18](https://nodejs.org/) and run the following command: npm init slidev ``` -Documentations: +Documentation: **[English](https://sli.dev)** | [中文文档](https://cn.sli.dev) | [Français](https://fr.sli.dev) | [Español](https://es.sli.dev) | [Русский](https://ru.sli.dev) | [Português-BR](https://br.sli.dev) Discord: [chat.sli.dev](https://chat.sli.dev) @@ -82,7 +82,7 @@ For a full example, you can check the [demo](https://github.com/slidevjs/slidev/ - [Shiki](https://github.com/shikijs/shiki), [Monaco Editor](https://github.com/Microsoft/monaco-editor) - First-class code snippets support with live coding capability - [RecordRTC](https://recordrtc.org) - Built-in recording and camera view - [VueUse](https://vueuse.org) family - [`@vueuse/core`](https://github.com/vueuse/vueuse), [`@vueuse/motion`](https://github.com/vueuse/motion), etc. -- [Iconify](https://iconify.design/) - Iconsets collection. +- [Iconify](https://iconify.design/) - Icon sets collection. - [Drauu](https://github.com/antfu/drauu) - Drawing and annotations support - [KaTeX](https://katex.org/) - LaTeX math rendering. - [Mermaid](https://mermaid-js.github.io/mermaid) - Textual Diagrams.