knight/datahub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[site/docs][m]: refactor docs section to live at docs and use dynamic routes.

Browse Source 
* This way adding new pages is just adding new markdown in markdowns folder (rather than having to create both markdown and a js file).
* Also renamed markdowns subfolder for docs stuff from api-doc to docs.
This commit is contained in:
Rufus Pollock 2021-06-20 21:55:00 +02:00
parent bb202e1828
commit 5185349829
9 changed files with 57 additions and 120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/markdowns/api-doc/components.md → docs/markdowns/docs/components.md
View File

0
docs/markdowns/api-doc/introduction.md → docs/markdowns/docs/index.md
View File

0
docs/markdowns/api-doc/installation.md → docs/markdowns/docs/installation.md
View File

0
docs/markdowns/api-doc/references.md → docs/markdowns/docs/references.md
View File

31
docs/pages/components.js
View File

@ -1,31 +0,0 @@
import Link from 'next/link'
import path from 'path'
import Layout from '../components/layout'
import Prose from '../components/prose'
import { formatMD } from '../lib/utils'
export default function Docs({ mdFile }) {
return (
<Layout title="Portal.js API Documentation">
<Prose mdFile={mdFile}>
<p className="text-center">
<Link href="/components">
<button>Next Page</button>
</Link>
</p>
</Prose>
</Layout>
)
}
export async function getStaticProps() {
const mdFilePath = path.join(process.cwd(), "markdowns/api-doc/installation.md")
const mdFile = await formatMD(mdFilePath)
return {
props: {
mdFile
}
}
}

31
docs/pages/docs.js
View File

@ -1,31 +0,0 @@
import Link from 'next/link'
import path from 'path'
import Layout from '../components/layout'
import Prose from '../components/prose'
import { formatMD } from '../lib/utils'
export default function Docs({ mdFile }) {
return (
<Layout title="Portal.js API Documentation">
<Prose mdFile={mdFile}>
<p className="text-center">
<Link href="/installation">
<button>Next Page</button>
</Link>
</p>
</Prose>
</Layout>
)
}
export async function getStaticProps() {
const mdFilePath = path.join(process.cwd(), "markdowns/api-doc/introduction.md")
const mdFile = await formatMD(mdFilePath)
return {
props: {
mdFile
}
}
}

57
docs/pages/docs/[[...id]].js Normal file
View File

@ -0,0 +1,57 @@
import path from 'path'
import * as fs from 'fs'
import Link from 'next/link'
import Layout from '../../components/layout'
import Prose from '../../components/prose'
import { formatMD } from '../../lib/utils'
export default function Docs({ title, mdFile }) {
return (
<Layout title="Portal.js Documentation - {title}">
<Prose mdFile={mdFile}>
<p className="text-center">
<Link href="/installation">
<button>Next Page</button>
</Link>
</p>
</Prose>
</Layout>
)
}
const postsDirectory = 'markdowns/docs'
export async function getStaticProps({params}) {
const postId = params.id ? params.id : 'index'
const mdFilePath = path.join(postsDirectory, postId + '.md')
const mdFile = await formatMD(mdFilePath)
return {
props: {
mdFile
}
}
}
export async function getStaticPaths() {
const fileNames = fs.readdirSync(postsDirectory)
const paths = fileNames.map(fileName => {
if (fileName == 'index.md') {
return {
params: {
id: null
}
}
} else {
return {
params: {
id: [ fileName.replace(/\.md$/, '') ]
}
}
}
})
return {
paths: paths,
fallback: false
}
}

31
docs/pages/installation.js
View File

@ -1,31 +0,0 @@
import Link from 'next/link'
import path from 'path'
import Layout from '../components/layout'
import Prose from '../components/prose'
import { formatMD } from '../lib/utils'
export default function Docs({ mdFile }) {
return (
<Layout title="Portal.js Installation">
<Prose mdFile={mdFile}>
<p className="text-center">
<Link href="/references">
<button>Next Page</button>
</Link>
</p>
</Prose>
</Layout>
)
}
export async function getStaticProps() {
const mdFilePath = path.join(process.cwd(), "markdowns/api-doc/installation.md")
const mdFile = await formatMD(mdFilePath)
return {
props: {
mdFile
}
}
}

27
docs/pages/references.js
View File

@ -1,27 +0,0 @@
import Link from 'next/link'
import path from 'path'
import Layout from '../components/layout'
import Prose from '../components/prose'
import { formatMD } from '../lib/utils'
export default function Docs({ mdFile }) {
return (
<Layout title="Portal.js Reference Documentation">
<Prose mdFile={mdFile}>
</Prose>
</Layout>
)
}
export async function getStaticProps() {
const mdFilePath = path.join(process.cwd(), "markdowns/api-doc/references.md")
const mdFile = await formatMD(mdFilePath)
return {
props: {
mdFile
}
}
}