Commit 7f0bb2b4 authored by Johan Richer's avatar Johan Richer
Browse files

Merge 2 FAQ repos

parent 0c2e8686
Pipeline #283 failed with stages
in 1 minute and 56 seconds
module.exports = {
title: 'GitLab Documentation',
description: 'Documentation for the Digital Transport Resource Center',
base: '/gitlab-doc/',
themeConfig: {
sidebar: [
'/data-faq/',
'/doc-faq/'
],
sidebarDepth: 1,
repo: 'https://git.digitaltransport4africa.org/doc/gitlab-doc',
docsDir: '.',
editLinks: true,
editLinkText: 'Éditer sur GitLab',
nav: [
{text: 'DT4A', link: 'https://digitaltransport4africa.org/'},
{text: 'Resource Center', link: 'https://git.digitaltransport4africa.org/'},
],
lastUpdated: 'Dernière mise à jour',
}
}
![Build Status](https://gitlab.com/samdbeckham/vuepress-gl-pages/badges/master/build.svg)
# Documentation for the Digital Transport Resource Center
---
Example [VuePress][project] website using GitLab Pages.
Learn more about GitLab Pages at https://pages.gitlab.io and the official
documentation https://docs.gitlab.com/ce/user/project/pages/.
---
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [GitLab CI](#gitlab-ci)
- [Building locally](#building-locally)
- [GitLab User or Group Pages](#gitlab-user-or-group-pages)
- [Did you fork this project?](#did-you-fork-this-project)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## GitLab CI
This project's static Pages are built by [GitLab CI][ci], following the steps
defined in [`.gitlab-ci.yml`](.gitlab-ci.yml):
```
image: node:9.11.1
pages:
cache:
paths:
- node_modules/
script:
- yarn install
- yarn build
artifacts:
paths:
- public
only:
- master
```
This sets up a `node9.11.1` environment, then uses `yarn install` to install dependencies and `yarn build` to build out the website to the `./public` directory.
It also caches the `node_modules` directory to speed up subsequent builds.
## Building locally
This project uses [yarn](https://yarnpkg.com), you'll need to install this globally before you can get started.
```
npm install -g yarn
```
Then you need to install the project dependencies:
```
yarn install
```
Now you're ready to go.
To run the local dev server just use the following command:
```
yarn start
```
Your website should be available at [http://localhost:8080/vuepress]
*Read more at VuePress' [documentation][].*
## GitLab User or Group Pages
To use this project as your user/group website, you will need one additional
step: just rename your project to `namespace.gitlab.io`, where `namespace` is
your `username` or `groupname`. This can be done by navigating to your
project's **Settings**.
Read more about [user/group Pages][userpages] and [project Pages][projpages].
## Project name
You'll need to set the correct base in docs/.vuepress/config.js.
If you are deploying to https://<USERNAME or GROUP>.gitlab.io/, you can omit base as it defaults to "/".
If you are deploying to https://<USERNAME or GROUP>.gitlab.io/<REPO>/, (i.e. your repository is at https://gitlab.com/<USERNAME>/<REPO>), set base to "/<REPO>/".
## Did you fork this project?
If you forked this project for your own use, please go to your project's
**Settings** and remove the forking relationship, which won't be necessary
unless you want to contribute back to the upstream project.
[ci]: https://about.gitlab.com/gitlab-ci/
[project]: https://vuepress.vuejs.org/
[install]: https://vuepress.vuejs.org/guide/getting-started.html
[documentation]: https://vuepress.vuejs.org/guide/
[userpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#user-or-group-pages
[projpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#project-pages
----
Forked from @samdbeckham
## Click on a link in the sidebar on left side of your screen to begin.
data-faq @ 7a75279b
Subproject commit 7a75279b99422c3e5e8cfa76be54e3d41d17fbc2
doc-faq @ 4a8fff9a
Subproject commit 4a8fff9ab221f3008f9365ebc4a6379347f834fa
module.exports = {
title: 'GitLab ❤️ VuePress',
description: 'Vue-powered static site generator running on GitLab Pages',
base: '/vuepress/',
dest: 'public'
}
\ No newline at end of file
---
home: true
heroImage: /hero.png
features:
- title: Simplicity First
details: Minimal setup with markdown-centered project structure helps you focus on writing.
- title: Vue-Powered
details: Enjoy the dev experience of Vue + webpack, use Vue components in markdown, and develop custom themes with Vue.
- title: Performant
details: VuePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded.
footer: MIT Licensed | Copyright © 2018-present Evan You
---
\ No newline at end of file
......@@ -7,8 +7,8 @@
"license": "MIT",
"private": false,
"scripts": {
"start": "vuepress dev docs",
"build": "vuepress build docs"
"start": "vuepress dev",
"build": "vuepress build"
},
"dependencies": {},
"devDependencies": {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment