AppSeed Docs

The official documentation repo for all web apps and boilerplate code

How to build the docs

The project uses Mkdocs to generate the HTML pages from Markdown files. To build locally the project, Nodejs must be installed.

$ # Clone Sources
$ git clone https://github.com/app-generator/docs.git
$ cd docs
$
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .\env\Scripts\activate
$
$ # Install requirements (mkdoks & related extensions)
$ pip3 install -r requirements.txt
$
$ # Install modules
$ yarn
$
$ # Start the app
$ yarn start
$
$ # Please visit http://localhost:8000 in browser

How to contribute

Each page provides Edit on github shortcut button in the top bar (see below). By clicking on it, the user is redirected to Github and invited to fork, edit the page and make a pull request to notify the owner that the content is updated.

The pull request triggered by the change will be merged in the documentation after validation.

For more information please contact the Support team on Discord server.

Latest Products

Django Bootstrap 5 Volt Dashboard (free product)
Flask Bootstrap 5 Volt Dashboard (free product)
Flask Star Admin PRO - product help, LIVE Demo
Flask Star Admin Black PRO - product help, LIVE Demo
Flask Star Admin Boxed PRO - product help, LIVE Demo

Latest Content Items

Flask Boilerplate - Help page
Flask Dashboard Boilerplate - Help page
Django Boilerplate - Help page
Django Dashboard Boilerplate - Help page
Code a simple app in Flask
Install Python38 on Ubuntu
Admin Dashboards - the index was updated with new items
Flask Dashboard Black - product help
Flask Dashboard Argon - product help
Flask Dashboard Material - product help
Flask Dashboard CoreUI - product help

Latest update - Mkdocs core

Support include of markdown files

Help Snippet - Extracted from Mkdocs Github repository

# File: mkdocs.yml

markdown_extensions:
    - markdown_include.include:
        base_path: docs

Usage

# File: Markdown File Sample

{!some/dir/in/docs/filename.md!}

AppSeed Docs - Provided by the AppSeed

frankgmail / docs