Homec4science
Diffusion Open Access Compliance Check Tool (OACCT) (paginated-inlines) Browse

rOACCT/styleguide.config.js
bae3fc262dc5paginated-inlines

Last Change
Raw File

styleguide.config.js
View Options

// const path = require('path');
module.exports = {
title:"OACCT Documentation",
version:"1.0",
theme: {
color: {
link: '#3771C8',
linkHover: '#D40000'
},
fontFamily: {
base: 'Helvetica, Arial, sans-serif'
}
},
styleguideDir:"reactDoc/styleguide",
// styles: {
// Logo: {
// // We're changing the LogoRenderer component
// logo: {
// // We're changing the rsg--logo-XX class name inside the component
// // animation: '$blink ease-in-out 300ms infinite'
// // },
// // '@keyframes blink': {
// // to: { opacity: 0 }
// // }
// }
// },
sections: [
{
name: 'Introduction',
content: './assets/docs/introduction.md'
},
{
name: 'Documentation',
sections: [
{
name: 'Installation',
content: './assets/docs/installation.md',
description: 'The description for the installation section'
},
{
name: '[Django]Backend Configuration',
description: 'The description for the backend section using Django',
content: './assets/docs/backend_configuration.md'
},
{
name: '[React]Frontend Configuration',
description: 'The description for the ins Frontend section using React.js',
content: './assets/docs/frontend_configuration.md'
},
{
name: 'Live Demo',
external: true,
href: 'https://oacct-test.epfl.ch/#/'
}
]
},
{
name: 'React UI Components',
// content: 'docs/ui.md',
components: ['./assets/src/pages/**/*.js','./assets/src/components/**/*.js'],
exampleMode: 'expand', // 'hide' | 'collapse' | 'expand'
usageMode: 'expand' // 'hide' | 'collapse' | 'expand'
},
{
name: 'React context',
// content: 'docs/ui.md',
components: './assets/src/ContextProvider.js',
content: './assets/src/ContextProvider.md',
exampleMode: 'expand', // 'hide' | 'collapse' | 'expand'
usageMode: 'expand' // 'hide' | 'collapse' | 'expand'
},
{
name: 'API',
content: './assets/src/services/api.md',
exampleMode: 'expand', // 'hide' | 'collapse' | 'expand'
usageMode: 'expand', // 'hide' | 'collapse' | 'expand'
sections: [
{
name: 'Requests',
content: './assets/src/services/requests/requests.md',
description: 'What are the requests syntax?'
},
]
}
]
}
c4science · Help