Automatically build API documentation (#11)
* Automatically build API documentation using Typedoc and Docusaurus * Move MD and move to MDX for Docusaurus Guides
This commit is contained in:
110
docs/docusaurus.config.js
Normal file
110
docs/docusaurus.config.js
Normal file
@@ -0,0 +1,110 @@
|
||||
module.exports = {
|
||||
title: 'VisionCamera',
|
||||
tagline: '📸 The Camera library that sees the vision.',
|
||||
url: 'https://github.com/cuvent/react-native-vision-camera',
|
||||
baseUrl: '/',
|
||||
onBrokenLinks: 'throw',
|
||||
onBrokenMarkdownLinks: 'warn',
|
||||
favicon: './favicon.ico',
|
||||
organizationName: 'cuvent',
|
||||
projectName: 'react-native-vision-camera',
|
||||
themeConfig: {
|
||||
navbar: {
|
||||
title: 'VisionCamera',
|
||||
logo: {
|
||||
alt: 'Logo',
|
||||
src: 'https://github.com/cuvent/react-native-vision-camera/blob/main/img/11.png?raw=true',
|
||||
},
|
||||
items: [
|
||||
{
|
||||
label: 'Guides',
|
||||
to: 'docs/',
|
||||
position: 'left',
|
||||
},
|
||||
{
|
||||
to: 'docs/api',
|
||||
label: 'API',
|
||||
position: 'left'
|
||||
},
|
||||
{
|
||||
href: 'https://github.com/cuvent/react-native-vision-camera',
|
||||
label: 'GitHub',
|
||||
position: 'right',
|
||||
},
|
||||
],
|
||||
},
|
||||
footer: {
|
||||
style: 'dark',
|
||||
links: [
|
||||
{
|
||||
title: 'Docs',
|
||||
items: [
|
||||
{
|
||||
label: 'Guides',
|
||||
to: 'docs/'
|
||||
},
|
||||
{
|
||||
label: 'API',
|
||||
to: 'docs/api',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Community',
|
||||
items: [
|
||||
{
|
||||
label: 'GitHub discussions',
|
||||
href: 'https://github.com/cuvent/react-native-vision-camera/discussions',
|
||||
},
|
||||
{
|
||||
label: 'Twitter',
|
||||
href: 'https://twitter.com/mrousavy',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'More',
|
||||
items: [
|
||||
{
|
||||
label: 'GitHub',
|
||||
href: 'https://github.com/cuvent/react-native-vision-camera',
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
copyright: `Copyright © ${new Date().getFullYear()} Cuvent`,
|
||||
},
|
||||
},
|
||||
presets: [
|
||||
[
|
||||
'@docusaurus/preset-classic',
|
||||
{
|
||||
docs: {
|
||||
sidebarPath: require.resolve('./sidebars.js'),
|
||||
// Please change this to your repo.
|
||||
editUrl:
|
||||
'https://github.com/cuvent/react-native-vision-camera/edit/main/docs/',
|
||||
},
|
||||
theme: {
|
||||
customCss: require.resolve('./src/css/custom.css'),
|
||||
},
|
||||
},
|
||||
],
|
||||
],
|
||||
plugins: [
|
||||
[
|
||||
'docusaurus-plugin-typedoc',
|
||||
{
|
||||
entryPoints: ['../src'],
|
||||
tsconfig: '../tsconfig.json',
|
||||
readme: "none",
|
||||
out: 'api',
|
||||
sidebar: {
|
||||
sidebarFile: 'typedoc-sidebar.js',
|
||||
fullNames: true,
|
||||
readmeLabel: 'Overview'
|
||||
},
|
||||
},
|
||||
],
|
||||
],
|
||||
};
|
||||
Reference in New Issue
Block a user