qtpromise/docs/.vuepress/config.js
Simon Brunel 3c1461b8d0 Enhance the documentation and add markdown lint
- Add npm package.json to make easier maintaining dependencies.
- Make markdown files consistent using remark.
- Wrap markdown lines to 100 characters.
- Better README.md layout and visual.
- Enable VuePress landing/home page.
- Upgrade to latest VuePress version.
- Add link to the new Qt Marketplace.
2019-12-21 10:27:26 +01:00

78 lines
2.7 KiB
JavaScript

module.exports = {
title: 'QtPromise',
description: 'Promises/A+ implementation for Qt/C++',
dest: 'dist/docs',
ga: 'UA-113899811-1',
head: [
['link', { rel: 'icon', href: `/favicon.png` }],
],
themeConfig: {
repo: 'simonbrunel/qtpromise',
lastUpdated: 'Last Updated',
smoothScroll: true,
editLinks: true,
docsDir: 'docs',
algolia: {
apiKey: '0e6e9cccb8c2c360a5543e28c4e31cb8',
indexName: 'qtpromise'
},
nav: [
{ text: 'Home', link: '/' },
{ text: 'Guide', link: '/qtpromise/getting-started' },
{ text: 'API Reference', link: '/qtpromise/api-reference' },
],
sidebar: [
'/qtpromise/getting-started',
'/qtpromise/qtconcurrent',
'/qtpromise/qtsignals',
'/qtpromise/thread-safety',
'/qtpromise/api-reference',
{
title: 'QPromise',
children: [
'/qtpromise/qpromise/constructor',
'/qtpromise/qpromise/delay',
'/qtpromise/qpromise/each',
'/qtpromise/qpromise/fail',
'/qtpromise/qpromise/filter',
'/qtpromise/qpromise/finally',
'/qtpromise/qpromise/isfulfilled',
'/qtpromise/qpromise/ispending',
'/qtpromise/qpromise/isrejected',
'/qtpromise/qpromise/map',
'/qtpromise/qpromise/reduce',
'/qtpromise/qpromise/tap',
'/qtpromise/qpromise/tapfail',
'/qtpromise/qpromise/then',
'/qtpromise/qpromise/timeout',
'/qtpromise/qpromise/wait',
'/qtpromise/qpromise/reject.md',
'/qtpromise/qpromise/resolve.md'
]
},
{
title: 'Helpers',
children: [
'/qtpromise/helpers/all',
'/qtpromise/helpers/attempt',
'/qtpromise/helpers/connect',
'/qtpromise/helpers/each',
'/qtpromise/helpers/filter',
'/qtpromise/helpers/map',
'/qtpromise/helpers/reduce',
'/qtpromise/helpers/resolve'
]
},
{
title: 'Exceptions',
children: [
'/qtpromise/exceptions/canceled',
'/qtpromise/exceptions/context',
'/qtpromise/exceptions/timeout',
'/qtpromise/exceptions/undefined'
]
}
]
}
}