vuepress-theme-abeeway v3.10.0

Abeeway Theme Vuepress

The abeeway theme offers a customized font style and a theme construction format.

Theme Initialisation

For install :

npm i vuepres-theme-abeeway

if you don't open your VNP, you will have a problem.

In node_modules/vuepress-theme-abeeway/example you have project type conception

Demo example to good congiguration

/**
 .
 ├── docs
 │   └── .vuepress
 │       └── config.js  <--- your here
 └── package.json
 **/
module.exports = {
    theme:'abeeway'
    // [ your body code ] //
}

Structure Of a Good Rendering

Simple

If you want to have a simple structure you should write in the following form the subtitles will be generated from <h1> to <h3> maximum.

Your default read file will be README.md this will be set to '/Guide/'.

/**
 .
 ├── docs
 │   ├── .vuepress 
 │   │   └── config.js <--- Write code
 │   └── Guide  <--- position of '/Guide/'
 │       └── README.md  <---- Render Origin
 │
 └── package.json
 **/
module.exports = {
    themeConfig: {
        sidebar: {
            '/Guide/': [
                {
                    title: 'Guide',
                    path: '/Guide/',
                    collapsable: false, 
                    sidebarDepth: 1,
                }
            ],
        }
    }
}

Multiple

To build nested pages, you need to create children of the pages you want to read.

/**
 .
 ├── docs
 │   ├── .vuepress 
 │   │   └── config.js <--- Write code
 │   └── Guide  <--- position of '/Guide/'
 │       ├── README.md  <---- Render Origin
 │       │
 │       └── file.md  <--- file read with path in childreen
 │
 └── package.json
 **/
module.exports = {
    themeConfig: {
        sidebar: {
            '/Guide/': [
                {
                    title: 'Guide',
                    path: '/Guide/',
                    collapsable: false, 
                    sidebarDepth: 1,
                    childreen : [
                        'file.md' // file read with path in childreen
                    ]
                }
            ],
        }
    }
}

More Multiple

To build nested pages you need to create children of the pages you want to open.

/**
 .
 ├── docs
 │   ├── .vuepress 
 │   │   └── config.js <--- Write code
 │   └── Guide  <--- position of '/Guide/'
 │       ├── README.md  <---- Render Origin
 │       │
 │       ├── file.md  <--- file read with path in childreen
 │       │
 │       └── myDirectory
 │              └── readme.md <--- Original position render to folder myDirectory
 │
 └── package.json
 **/
module.exports = {
    themeConfig: {
        sidebar: {
            '/Guide/': [
                {
                    title: 'Guide',
                    path: '/Guide/',
                    collapsable: false, 
                    sidebarDepth: 1,
                    childreen : [
                        'file.md',
                        {
                            title: 'My Directory',
                            path: '/Guide/myDirectory/',  // Path of file readme.md to myDirectory 
                            collapsable: true, 
                            sidebarDepth: 1,    
                        }
                    ]
                }
            ],
        }
    }
}

Bonus

The project edition bonus allows you to manage your project on the title and the baseURL that is the code

/**
 .
 ├── docs
 │   └── .vuepress
 │       └── config.js  <--- your here
 └── package.json
 **/
var version = fs.readFileSync('../Version', 'utf8').trim();

module.exports = {
    /** bonus **/
    title: getTitle,
    base: getBase(),
    /** **/
    themeConfig: {
        // code //
    }
}
/** bonus functions **/
function getTitle() {
    return 'Abeeway Theme Vuepress (' + version + ')';
}

function getBase() {
    if (version.endsWith("-SNAPSHOT")) {
        return "/abeeway/";
    }
    var rx = /([0-9]*\.[0-9]*).*/g;
    var result = rx.exec(version);
    return "/abeeway/" + result[1] + "/";
}

• var version = fs.readFileSync('../Version', 'utf8').trim(); : path to Version.txt write just 1.0.0

• function getTitle() : Conception title with Version.txt text inside

• function getBase() : Conception base (URL) to Version.txt text inside