From 327f091d8a1acba96d7841a6f033e14d835cd780 Mon Sep 17 00:00:00 2001 From: pranavnt <46251241+pranavnt@users.noreply.github.com> Date: Sat, 8 May 2021 21:00:46 +0000 Subject: [PATCH] Initial commit Created from https://vercel.com/new --- .gitignore | 7 + .prettierignore | 2 + LICENSE | 21 + next.config.js | 2 + package.json | 27 + pages/_app.js | 5 + pages/advanced/code-highlighting.mdx | 26 + pages/advanced/meta.json | 3 + pages/blog/get-started.mdx | 47 + pages/blog/meta.json | 3 + pages/docs/anchors.md | 57 + pages/docs/built-in-components.mdx | 81 + pages/docs/get-started.mdx | 78 + pages/docs/meta.json | 6 + pages/docs/structure.md | 7 + pages/features/i18n.md | 40 + pages/features/mdx.mdx | 119 ++ pages/features/meta.json | 5 + pages/features/ssg.mdx | 32 + pages/index.mdx | 12 + pages/meta.json | 7 + public/android-icon-192x192.png | Bin 0 -> 15416 bytes public/apple-icon-180x180.png | Bin 0 -> 15513 bytes public/apple-icon.png | Bin 0 -> 15990 bytes public/demo.png | Bin 0 -> 386971 bytes public/favicon-16x16.png | Bin 0 -> 1470 bytes public/favicon-32x32.png | Bin 0 -> 2201 bytes public/favicon-96x96.png | Bin 0 -> 6701 bytes public/favicon.ico | Bin 0 -> 1150 bytes public/ms-icon-144x144.png | Bin 0 -> 11130 bytes public/og.png | Bin 0 -> 950286 bytes readme.md | 22 + theme.config.js | 65 + yarn.lock | 2818 ++++++++++++++++++++++++++ 34 files changed, 3492 insertions(+) create mode 100644 .gitignore create mode 100644 .prettierignore create mode 100644 LICENSE create mode 100644 next.config.js create mode 100644 package.json create mode 100644 pages/_app.js create mode 100644 pages/advanced/code-highlighting.mdx create mode 100644 pages/advanced/meta.json create mode 100644 pages/blog/get-started.mdx create mode 100644 pages/blog/meta.json create mode 100644 pages/docs/anchors.md create mode 100644 pages/docs/built-in-components.mdx create mode 100644 pages/docs/get-started.mdx create mode 100644 pages/docs/meta.json create mode 100644 pages/docs/structure.md create mode 100644 pages/features/i18n.md create mode 100644 pages/features/mdx.mdx create mode 100644 pages/features/meta.json create mode 100644 pages/features/ssg.mdx create mode 100644 pages/index.mdx create mode 100644 pages/meta.json create mode 100644 public/android-icon-192x192.png create mode 100644 public/apple-icon-180x180.png create mode 100644 public/apple-icon.png create mode 100644 public/demo.png create mode 100644 public/favicon-16x16.png create mode 100644 public/favicon-32x32.png create mode 100644 public/favicon-96x96.png create mode 100644 public/favicon.ico create mode 100644 public/ms-icon-144x144.png create mode 100644 public/og.png create mode 100644 readme.md create mode 100644 theme.config.js create mode 100644 yarn.lock diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fbea7fd --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +node_modules +.next +.DS_Store +yarn-error.log +dist +examples +packages \ No newline at end of file diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..f74c781 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,2 @@ +.next +node_modules diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6734428 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 Shu Ding + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/next.config.js b/next.config.js new file mode 100644 index 0000000..851af14 --- /dev/null +++ b/next.config.js @@ -0,0 +1,2 @@ +const withNextra = require('nextra')('nextra-theme-docs', './theme.config.js') +module.exports = withNextra() diff --git a/package.json b/package.json new file mode 100644 index 0000000..60439ae --- /dev/null +++ b/package.json @@ -0,0 +1,27 @@ +{ + "name": "nextra", + "version": "1.0.0", + "description": "", + "main": "index.js", + "scripts": { + "dev": "next", + "start": "next start", + "build": "next build" + }, + "author": "Shu Ding", + "license": "MIT", + "dependencies": { + "next": "^10.0.8-canary.9", + "nextra": "^0.4.1", + "nextra-theme-docs": "^1.1.2", + "react": "^17.0.1", + "react-dom": "^17.0.1" + }, + "devDependencies": { + "prettier": "^2.0.5" + }, + "prettier": { + "semi": false, + "singleQuote": true + } +} diff --git a/pages/_app.js b/pages/_app.js new file mode 100644 index 0000000..3e7701b --- /dev/null +++ b/pages/_app.js @@ -0,0 +1,5 @@ +import 'nextra-theme-docs/style.css' + +export default function Nextra({ Component, pageProps }) { + return +} diff --git a/pages/advanced/code-highlighting.mdx b/pages/advanced/code-highlighting.mdx new file mode 100644 index 0000000..87703c8 --- /dev/null +++ b/pages/advanced/code-highlighting.mdx @@ -0,0 +1,26 @@ +# Code Highlighting + +`nextra-theme-docs` uses [Prism](https://prismjs.com) and [prism-react-renderer](https://github.com/FormidableLabs/prism-react-renderer) +to highlight the code blocks. This section covers how you can customze it. + +## More Languages + +To keep the bundle small, only a [subset of languages](https://github.com/FormidableLabs/prism-react-renderer/blob/master/src/vendor/prism/includeLangs.js) +are included in the syntax highlighter. If you want to add more languages, you can do the following: + +1. Run `yarn add prismjs prism-react-renderer` to add dependencies to your Nextra project. +2. Add the following code to your `pages/_app.js`: + +```jsx +import Prism from 'prism-react-renderer/prism' + +(typeof global !== "undefined" ? global : window).Prism = Prism + +require("prismjs/components/prism-kotlin") +require("prismjs/components/prism-csharp") +``` + +Restart your app and you will have Kotlin and C# code highlighting supported. +You can find the full list of available languages [here](https://github.com/PrismJS/prism/tree/master/components). + +{/*## Custom Themes*/} diff --git a/pages/advanced/meta.json b/pages/advanced/meta.json new file mode 100644 index 0000000..b3382bd --- /dev/null +++ b/pages/advanced/meta.json @@ -0,0 +1,3 @@ +{ + "code-highlighting": "Code Highlighting" +} \ No newline at end of file diff --git a/pages/blog/get-started.mdx b/pages/blog/get-started.mdx new file mode 100644 index 0000000..cd5d6d8 --- /dev/null +++ b/pages/blog/get-started.mdx @@ -0,0 +1,47 @@ +# Get Started + +### Configurations + +1. Install Next.js and React: `yarn add next react react-dom` + +2. Install Nextra and the blog theme: `yarn add nextra nextra-theme-blog` + +3. Create the following Next.js config and theme config under the root directory: + +```jsx +// next.config.js +const withNextra = require('nextra')('nextra-theme-blog', './theme.config.js') +module.exports = withNextra() +``` + +```jsx +// theme.config.js +export default { + footer:

MIT 2020 © Shu Ding.

, + head: <> + + + + +} +``` + +4. Create `pages/_app.js` and include the theme stylesheet: + +```jsx +import 'nextra-theme-blog/style.css' + +export default function Nextra({ Component, pageProps }) { + return +} +``` + +5. You are good to go! + +--- + +import Callout from 'nextra-theme-docs/callout' + + +You can also use [`