search

iam-concepts / doc-site

Vuepress based documentation site for whole iam-concepts
MIT License
0 stars 0 forks source link

Vuepress based documentation site creation #1

Open adriatic opened 3 years ago

adriatic commented 3 years ago

Skeleton creation

There are way too many articles on constructing the vuepress documentation and blog site, all of them being behind (as too old) the current state of the vuepress, described in https://vuepress.vuejs.org/guide/getting-started.html#prerequisites. So we should use the Manual Installation - that will be the staring template for all Vuepress project (kept in C:\work\blog\vuepress\vuepress-starter)

Note: using the "quick start" creation of the basic vuepress skeleton:

yarn create vuepress-site [optionalDirectoryName]

is equivalent to the Manual Installation because the invocation of the vuepress-site (in yarn create vuepress-site) is equivalent to the sum of steps in "manual installation". The key steps in that sum are yarn add -D vuepress and the creation of the scripts section in the package.json file

See https://techsparx.com/nodejs/tools/npm-build-scripts.html for more information on how npm and yarn use the scripts section in package.json.

Also see my own question and my reply in StackOverflow: https://stackoverflow.com/questions/64839895/how-does-yarn-find-a-module-installed-as-a-dev-dependency/

The created skeleton has the following structure:

image

Additional information

VuePress: Static Blog using Vue.js Creating a VuePress Blog

adriatic commented 3 years ago

Creation of the Documentation Site, using the Skeleton defined above

Use the VuePress Book tutorial as the guide and pickup from Creating the directories for your VuePress site, Windows version, using the "root folder names" to fit our existing skeleton. This approach results in further scale-down to"

image