amass/qtpromise
1
0
Fork 0
mirror of https://github.com/simonbrunel/qtpromise.git synced 2024-11-22 19:00:05 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
60b36e7a70
qtpromise/docs/.vuepress/config.js

89 lines
3.4 KiB
JavaScript
Raw Normal View History

Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
module.exports = {
title: 'QtPromise',
description: 'Promises/A+ implementation for Qt/C++',
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 17:27:26 +08:00
dest: 'dist/docs',
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
head: [
['link', { rel: 'icon', href: `/favicon.png` }],
],
Fix Google Analytics plugin docs config
2020-01-24 11:58:32 +08:00
plugins: [
['@vuepress/google-analytics', {
ga: 'UA-113899811-1'
}]
],
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
themeConfig: {
repo: 'simonbrunel/qtpromise',
lastUpdated: 'Last Updated',
Add CMake support and enhance the getting started docs - Add a root CMakeLists.txt defining an INTERFACE target. - Add CMake, qpm, Git and download installation instructions. - Add CMake and qmake integration instructions. - Remove smooth scroll when navigating the docs. - Add links validation to `npm run docs:link`. - Reorganize the sidebar API Reference section.
2020-01-10 03:41:09 +08:00
smoothScroll: false,
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
editLinks: true,
Add CMake support and enhance the getting started docs - Add a root CMakeLists.txt defining an INTERFACE target. - Add CMake, qpm, Git and download installation instructions. - Add CMake and qmake integration instructions. - Remove smooth scroll when navigating the docs. - Add links validation to `npm run docs:link`. - Reorganize the sidebar API Reference section.
2020-01-10 03:41:09 +08:00
sidebarDepth: 2,
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
docsDir: 'docs',
Integrate DocSearch (Algolia) https://github.com/algolia/docsearch-configs/blob/master/configs/qtpromise.json https://community.algolia.com/docsearch/
2018-09-10 18:36:31 +08:00
algolia: {
apiKey: '0e6e9cccb8c2c360a5543e28c4e31cb8',
indexName: 'qtpromise'
},
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 17:27:26 +08:00
nav: [
{ text: 'Home', link: '/' },
{ text: 'Guide', link: '/qtpromise/getting-started' },
{ text: 'API Reference', link: '/qtpromise/api-reference' },
],
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
sidebar: [
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 17:27:26 +08:00
'/qtpromise/getting-started',
'/qtpromise/qtconcurrent',
'/qtpromise/qtsignals',
'/qtpromise/thread-safety',
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
{
Add CMake support and enhance the getting started docs - Add a root CMakeLists.txt defining an INTERFACE target. - Add CMake, qpm, Git and download installation instructions. - Add CMake and qmake integration instructions. - Remove smooth scroll when navigating the docs. - Add links validation to `npm run docs:link`. - Reorganize the sidebar API Reference section.
2020-01-10 03:41:09 +08:00
title: 'API Reference',
path: '/qtpromise/api-reference',
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
children: [
Add CMake support and enhance the getting started docs - Add a root CMakeLists.txt defining an INTERFACE target. - Add CMake, qpm, Git and download installation instructions. - Add CMake and qmake integration instructions. - Remove smooth scroll when navigating the docs. - Add links validation to `npm run docs:link`. - Reorganize the sidebar API Reference section.
2020-01-10 03:41:09 +08:00
//['/qtpromise/api-reference', 'Overview'],
{
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',
'/qtpromise/qpromise/resolve'
]
},
{
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'
]
}
Add documentation for built-in exceptions
2019-02-01 23:06:29 +08:00
]
Migrate documentation to VuePress GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
2018-09-07 23:50:09 +08:00
}
]
}
}
Reference in New Issue Copy Permalink