-
16 | {menus.map(route => (
17 |
- 18 | {route.slug ? ( 19 | 20 | {route.navigationLabel} 21 | {route.menu && createTree(route.menu)} 22 | 23 | ) : ( 24 | 25 | {route.navigationLabel} 26 | {route.menu && createTree(route.menu)} 27 | 28 | )} 29 | 30 | ))} 31 |
-
74 |
- 75 | 79 | GitHub: gatsby-mdx-routes 80 | 81 | 82 |
- 83 | 87 | npm: @pauliescanlon/gatsby-mdx-routes 88 | 89 | 90 |
routes
94 |
95 | Simple example routes.map
96 |
routes navigationOrder
111 |
112 | Simple example routes.map with{" "}
113 | navigationOrder
114 |
menus
139 |
140 | Recursive example createTree
141 |
menus navigationOrder
146 |
147 | Recursive example createTree with{" "}
148 | navigationOrder
149 |
3 |
4 | 
5 |
6 |
8 | Gatsby's default starter 9 |
10 | 11 | Kick off your project with this default boilerplate. This starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React. 12 | 13 | _Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://www.gatsbyjs.org/docs/gatsby-starters/)._ 14 | 15 | ## 🚀 Quick start 16 | 17 | 1. **Create a Gatsby site.** 18 | 19 | Use the Gatsby CLI to create a new site, specifying the default starter. 20 | 21 | ```shell 22 | # create a new Gatsby site using the default starter 23 | gatsby new my-default-starter https://github.com/gatsbyjs/gatsby-starter-default 24 | ``` 25 | 26 | 1. **Start developing.** 27 | 28 | Navigate into your new site’s directory and start it up. 29 | 30 | ```shell 31 | cd my-default-starter/ 32 | gatsby develop 33 | ``` 34 | 35 | 1. **Open the source code and start editing!** 36 | 37 | Your site is now running at `http://localhost:8000`! 38 | 39 | _Note: You'll also see a second link: _`http://localhost:8000/___graphql`_. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._ 40 | 41 | Open the `my-default-starter` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time! 42 | 43 | ## 🧐 What's inside? 44 | 45 | A quick look at the top-level files and directories you'll see in a Gatsby project. 46 | 47 | . 48 | ├── node_modules 49 | ├── src 50 | ├── .gitignore 51 | ├── .prettierrc 52 | ├── gatsby-browser.js 53 | ├── gatsby-config.js 54 | ├── gatsby-node.js 55 | ├── gatsby-ssr.js 56 | ├── LICENSE 57 | ├── package-lock.json 58 | ├── package.json 59 | └── README.md 60 | 61 | 1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed. 62 | 63 | 2. **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”. 64 | 65 | 3. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for. 66 | 67 | 4. **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent. 68 | 69 | 5. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser. 70 | 71 | 6. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail). 72 | 73 | 7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process. 74 | 75 | 8. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering. 76 | 77 | 9. **`LICENSE`**: Gatsby is licensed under the MIT license. 78 | 79 | 10. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).** 80 | 81 | 11. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project. 82 | 83 | 12. **`README.md`**: A text file containing useful reference information about your project. 84 | 85 | ## 🎓 Learning Gatsby 86 | 87 | Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start: 88 | 89 | - **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process. 90 | 91 | - **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar. 92 | 93 | ## 💫 Deploy 94 | 95 | [](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-default) 96 | 97 | 98 | -------------------------------------------------------------------------------- /@pauliescanlon/gatsby-mdx-routes/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | /* Basic Options */ 4 | // "incremental": true, /* Enable incremental compilation */ 5 | "target": "ES6" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */, 6 | "module": "none" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */, 7 | // "lib": [], /* Specify library files to be included in the compilation. */ 8 | "allowJs": true /* Allow javascript files to be compiled. */, 9 | // "checkJs": true, /* Report errors in .js files. */ 10 | "jsx": "react" /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */, 11 | "declaration": true /* Generates corresponding '.d.ts' file. */, 12 | // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ 13 | // "sourceMap": true, /* Generates corresponding '.map' file. */ 14 | // "outFile": "./", /* Concatenate and emit output to single file. */ 15 | "outDir": "." /* Redirect output structure to the directory. */, 16 | // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ 17 | // "composite": true, /* Enable project compilation */ 18 | // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ 19 | // "removeComments": true, /* Do not emit comments to output. */ 20 | // "noEmit": true, /* Do not emit outputs. */ 21 | // "importHelpers": true, /* Import emit helpers from 'tslib'. */ 22 | // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ 23 | // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ 24 | 25 | /* Strict Type-Checking Options */ 26 | "strict": true /* Enable all strict type-checking options. */, 27 | // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ 28 | // "strictNullChecks": true, /* Enable strict null checks. */ 29 | // "strictFunctionTypes": true, /* Enable strict checking of function types. */ 30 | // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ 31 | // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ 32 | // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ 33 | // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ 34 | 35 | /* Additional Checks */ 36 | // "noUnusedLocals": true, /* Report errors on unused locals. */ 37 | // "noUnusedParameters": true, /* Report errors on unused parameters. */ 38 | // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ 39 | // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ 40 | 41 | /* Module Resolution Options */ 42 | "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */, 43 | // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ 44 | // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ 45 | // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ 46 | // "typeRoots": [], /* List of folders to include type definitions from. */ 47 | // "types": [], /* Type declaration files to be included in compilation. */ 48 | "allowSyntheticDefaultImports": true /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */, 49 | "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */, 50 | // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ 51 | // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ 52 | 53 | /* Source Map Options */ 54 | // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ 55 | // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ 56 | // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ 57 | // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ 58 | 59 | /* Experimental Options */ 60 | // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ 61 | // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ 62 | 63 | /* Advanced Options */ 64 | "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */ 65 | }, 66 | "include": ["./src/**/*"], 67 | "exclude": ["./node_modules/*"] 68 | } 69 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 |
3 | 
4 |
5 | 
6 |
7 | 
8 |
9 |
10 |
11 | # gatsby-mdx-routes
12 |
13 | gatsby-mdx-routes is a plugin that exposes links to `.mdx` files sourced from `src/pages`.
14 |
15 | This plugin aims to separate the data from the ui, which means the styling of your navigation is up to you.
16 |
17 | ## 👁️ Preview
18 |
19 | - [Live Demo](https://gatsby-mdx-routes.netlify.com/)
20 |
21 | ## 🚀 Getting started
22 |
23 | ### Install
24 |
25 | ```
26 | npm install @pauliescanlon/gatsby-mdx-routes
27 | ```
28 |
29 | ### Setup
30 |
31 | To source `.mdx` files from `src/pages` you'll need `gatsby-source-filesystem` and `gatsby-plugin-mdx` installed.
32 |
33 | Your `gatsby-config` should look something like this...
34 |
35 | ```js
36 | module.exports = {
37 | plugins: [
38 | {
39 | resolve: `gatsby-source-filesystem`,
40 | options: {
41 | name: `pages`,
42 | path: `${__dirname}/src/pages/`,
43 | },
44 | },
45 | {
46 | resolve: `gatsby-plugin-mdx`,
47 | options: {
48 | defaultLayouts: {
49 | default: `${__dirname}/src/layouts/layout.js`,
50 | },
51 | },
52 | },
53 | ],
54 | }
55 | ```
56 |
57 | If that's all setup you'll now need to add `@pauliescanlon/gatsby-mdx-routes` as a plugin of `gatsby-plugin-mdx` 😅
58 |
59 | ```js
60 | module.exports = {
61 | {
62 | resolve: `gatsby-plugin-mdx`,
63 | options: {
64 | defaultLayouts: {
65 | default: `${__dirname}/src/layouts/layout.js`,
66 | },
67 | plugins: [`@pauliescanlon/gatsby-mdx-routes`],
68 | },
69 | },
70 | }
71 | ```
72 |
73 | Using the `defaultLayouts` from `gatsby-plugin-mdx` allows you to create one file that will be repeated across pages.
74 |
75 | This is where we'll add `MdxRoutes`.
76 |
77 | ## MdxRoutes
78 |
79 | MdxRoutes returns two arrays, _routes_ which is a flat array and _menus_ which is created recursively and contains a `menu` array.
80 |
81 | You will probably use one or the other, not both.
82 |
83 | ### routes
84 |
85 | The `routes` array returns two object keys, one is the actual route to the file in question (`slug`), the other is the `navigationLabel` from _frontmatter_
86 |
87 | | Key | Description |
88 | | --------------- | ------------------------------------------ |
89 | | slug | Route to `.mdx` file |
90 | | navigationLabel | navigationLabel extracted from frontmatter |
91 |
92 | src/pages/a-page.mdx
93 |
94 | #### frontmatter
95 |
96 | ```js
97 | ---
98 | navigationLabel: Page Title
99 | ---
100 |
101 | ```
102 |
103 | src/layouts/layout.js
104 |
105 | ```js
106 | import React, { Fragment } from "react"
107 | import { Link } from "gatsby"
108 |
109 | import { MdxRoutes } from "@pauliescanlon/gatsby-mdx-routes"
110 |
111 | export default ({ children }) => (
112 | -
183 | {menus.map(route => (
184 |
- 185 | {route.slug ? ( 186 | 187 | {route.navigationLabel} 188 | {route.menu && createTree(route.menu)} 189 | 190 | ) : ( 191 | 192 | {route.navigationLabel} 193 | {route.menu && createTree(route.menu)} 194 | 195 | )} 196 | 197 | ))} 198 |
-
229 | {routes.map((route, index) => (
230 |
- 231 | {route.navigationLabel} 232 | 233 | ))} 234 |
2 |
3 | 
4 |
5 | 
6 |
7 | 
8 |
9 |
10 |
11 | # gatsby-mdx-routes
12 |
13 | gatsby-mdx-routes is a plugin that exposes links to `.mdx` files sourced from `src/pages`.
14 |
15 | This plugin aims to separate the data from the ui, which means the styling of your navigation is up to you.
16 |
17 | ## 👁️ Preview
18 |
19 | - [Live Demo](https://gatsby-mdx-routes.netlify.com/)
20 |
21 | ## 🚀 Getting started
22 |
23 | ### Install
24 |
25 | ```
26 | npm install @pauliescanlon/gatsby-mdx-routes
27 | ```
28 |
29 | ### Setup
30 |
31 | To source `.mdx` files from `src/pages` you'll need `gatsby-source-filesystem` and `gatsby-plugin-mdx` installed.
32 |
33 | Your `gatsby-config` should look something like this...
34 |
35 | ```js
36 | module.exports = {
37 | plugins: [
38 | {
39 | resolve: `gatsby-source-filesystem`,
40 | options: {
41 | name: `pages`,
42 | path: `${__dirname}/src/pages/`,
43 | },
44 | },
45 | {
46 | resolve: `gatsby-plugin-mdx`,
47 | options: {
48 | defaultLayouts: {
49 | default: `${__dirname}/src/layouts/layout.js`,
50 | },
51 | },
52 | },
53 | ],
54 | }
55 | ```
56 |
57 | If that's all setup you'll now need to add `@pauliescanlon/gatsby-mdx-routes` as a plugin of `gatsby-plugin-mdx` 😅
58 |
59 | ```js
60 | module.exports = {
61 | {
62 | resolve: `gatsby-plugin-mdx`,
63 | options: {
64 | defaultLayouts: {
65 | default: `${__dirname}/src/layouts/layout.js`,
66 | },
67 | plugins: [`@pauliescanlon/gatsby-mdx-routes`],
68 | },
69 | },
70 | }
71 | ```
72 |
73 | Using the `defaultLayouts` from `gatsby-plugin-mdx` allows you to create one file that will be repeated across pages.
74 |
75 | This is where we'll add `MdxRoutes`.
76 |
77 | ## MdxRoutes
78 |
79 | MdxRoutes returns two arrays, _routes_ which is a flat array and _menus_ which is created recursively and contains a `menu` array.
80 |
81 | You will probably use one or the other, not both.
82 |
83 | ### routes
84 |
85 | The `routes` array returns two object keys, one is the actual route to the file in question (`slug`), the other is the `navigationLabel` from _frontmatter_
86 |
87 | | Key | Description |
88 | | --------------- | ------------------------------------------ |
89 | | slug | Route to `.mdx` file |
90 | | navigationLabel | navigationLabel extracted from frontmatter |
91 |
92 | src/pages/a-page.mdx
93 |
94 | #### frontmatter
95 |
96 | ```js
97 | ---
98 | navigationLabel: Page Title
99 | ---
100 |
101 | ```
102 |
103 | src/layouts/layout.js
104 |
105 | ```js
106 | import React, { Fragment } from "react"
107 | import { Link } from "gatsby"
108 |
109 | import { MdxRoutes } from "@pauliescanlon/gatsby-mdx-routes"
110 |
111 | export default ({ children }) => (
112 | -
183 | {menus.map(route => (
184 |
- 185 | {route.slug ? ( 186 | 187 | {route.navigationLabel} 188 | {route.menu && createTree(route.menu)} 189 | 190 | ) : ( 191 | 192 | {route.navigationLabel} 193 | {route.menu && createTree(route.menu)} 194 | 195 | )} 196 | 197 | ))} 198 |
-
229 | {routes.map((route, index) => (
230 |
- 231 | {route.navigationLabel} 232 | 233 | ))} 234 |