Skip to content

Commit

Permalink
docs: index docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eungyeole committed Oct 30, 2024
1 parent 566c454 commit 75cd8f0
Show file tree
Hide file tree
Showing 10 changed files with 16 additions and 40 deletions.
5 changes: 0 additions & 5 deletions docs/docs/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@
"link": "/guide/",
"activeMatch": "/guide/"
},
{
"text": "Hello World",
"link": "/hello/",
"activeMatch": "/hello/"
},
{
"text": "API",
"link": "https://rspress.dev/api/index.html"
Expand Down
5 changes: 0 additions & 5 deletions docs/docs/hello.md

This file was deleted.

37 changes: 12 additions & 25 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,23 @@
pageType: home

hero:
name: rsbuild-plugin-web-extension
text: rbsuild plugin for chrome/web extension
tagline: docs is WIP
text: rsbuild-plugin-web-extension
tagline: rsbuild plugin for chrome/web extension
actions:
- theme: brand
text: Quick Start
link: /guide/
- theme: alt
text: GitHub
link: https://github.com/web-infra-dev/rspress
image:
src: /rspress-icon.png
alt: rsbuild-plugin-web-extension Logo
link: https://github.com/filc-dev/rsbuild-plugin-web-extension
features:
- title: Blazing fast build speed
details: The core compilation module is based on the Rust front-end toolchain, providing a more ultimate development experience.
icon: 🏃🏻‍♀️
- title: Support for MDX content writing
details: MDX is a powerful way to write content, allowing you to use React components in Markdown.
icon: 📦
- title: Built-in full-text search
details: Automatically generates a full-text search index for you during construction, providing out-of-the-box full-text search capabilities.
icon: 🎨
- title: Simpler I18n solution
details: With the built-in I18n solution, you can easily provide multi-language support for documents or components.
icon: 🌍
- title: Static site generation
details: In production, it automatically builds into static HTML files, which can be easily deployed anywhere.
icon: 🌈
- title: Providing multiple custom capabilities
details: Through its extension mechanism, you can easily extend theme UI and build process.
icon: 🔥
- title: Cross Browser Support
details: Ensure your web extension works seamlessly across different browsers, including Chrome, Firefox, and more.
icon: 🌐
- title: Frontend Framework Support
details: Develop web extensions with your preferred frontend framework, including React, Svelete, and Vue.
icon: 🚧
- title: TypeScript Support
details: Write robust and maintainable code with TypeScript support, ensuring type safety and better code completion.
icon: 💻
---
Binary file added docs/docs/public/logo-black.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/public/logo-white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/public/rspress-dark-logo.png
Binary file not shown.
Binary file removed docs/docs/public/rspress-icon.png
Binary file not shown.
Binary file removed docs/docs/public/rspress-light-logo.png
Binary file not shown.
7 changes: 3 additions & 4 deletions docs/rspress.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,16 @@ export default defineConfig({
root: path.join(__dirname, "docs"),
title: "rsbuild-plugin-web-extension",
description: "rbsuild plugin for chrome/web extension",
icon: "/rspress-icon.png",
logo: {
light: "/rspress-light-logo.png",
dark: "/rspress-dark-logo.png",
light: "/logo-black.png",
dark: "/logo-white.png",
},
themeConfig: {
socialLinks: [
{
icon: "github",
mode: "link",
content: "https://github.com/web-infra-dev/rspress",
content: "https://github.com/filc-dev/rsbuild-plugin-web-extension",
},
],
},
Expand Down
2 changes: 1 addition & 1 deletion pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 75cd8f0

Please sign in to comment.