Skip to content

Commit 32d68d1

Browse files
mrholekmrholek
committed
docs: add documentation
1 parent 1cb0d9b commit 32d68d1

File tree

2 files changed

+153
-19
lines changed

2 files changed

+153
-19
lines changed

‎src/pug/_partials/sidebar.pug

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -218,26 +218,11 @@
218218
svg.nav-icon
219219
use(xlink:href="node_modules/@coreui/icons/sprites/free.svg#cil-bug")
220220
| Error 500
221-
//- li.nav-group.mt-auto
222-
//- a.nav-link.nav-group-toggle(href='#')
223-
//- svg.nav-icon
224-
//- use(xlink:href="node_modules/@coreui/icons/sprites/free.svg#cil-description")
225-
//- | Docs
226-
//- ul.nav-group-items
227-
//- li.nav-item
228-
//- a.nav-link(href='docs/installation.html')
229-
//- | Getting Started
230-
//- li.nav-item
231-
//- a.nav-link(href='docs/usage.html')
232-
//- | Usage
233-
//- li.nav-item
234-
//- a.nav-link(href='docs/contents.html')
235-
//- | Contents
236-
li.nav-item
237-
a.nav-link.nav-link-success(href="https://coreui.io" target="_top")
221+
li.nav-item.mt-auto
222+
a.nav-link(href='docs.html')
238223
svg.nav-icon
239-
use(xlink:href="node_modules/@coreui/icons/sprites/free.svg#cil-cloud-download")
240-
| Download CoreUI
224+
use(xlink:href="node_modules/@coreui/icons/sprites/free.svg#cil-description")
225+
| Docs
241226
li.nav-item
242227
a.nav-link.nav-link-danger(href="https://coreui.io/pro/" target="_top")
243228
svg.nav-icon

‎src/pug/views/docs.pug

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
extends ../_layout/default.pug
2+
3+
block view
4+
.card.mb-3
5+
.card-header
6+
strong Documentation
7+
.card-body
8+
p
9+
| CoreUI Free Bootstrap Admin Template is built on top of
10+
a(href='https://coreui.io/bootstrap/ui-components/') CoreUI UI Components Library
11+
|, so if you're looking for documentation for a specific component please check this
12+
a(href='https://coreui.io/docs/4.0/components/') documentation.
13+
14+
15+
h2 Installation
16+
17+
p CoreUI Free Bootstrap Admin Template can be installed in two ways.
18+
19+
h3 Download
20+
21+
p
22+
| Visit our
23+
a(href='https://coreui.io/') website
24+
| to download the latest version.
25+
26+
a(href='https://coreui.io/#compare' class='btn btn-primary') Download
27+
28+
h3(class='mt-3') Clone repo
29+
30+
pre.hljs.language-bash
31+
code
32+
| # clone the repo
33+
| $ git clone https://github.com/coreui/coreui-free-bootstrap-admin-template.git my-project
34+
|
35+
| # go into app's directory
36+
| $ cd my-project
37+
|
38+
| # install app's dependencies
39+
| $ npm install
40+
41+
h2(class='mt-5') Usage
42+
43+
h3#tooling-setup
44+
| Tooling setup
45+
p
46+
| CoreUI Admin Template uses
47+
a(href='https://docs.npmjs.com/misc/scripts/') npm scripts
48+
| for its build system. Our
49+
a(href='https://github.com/coreui/coreui-free-bootstrap-admin-template/blob/v4.0.0/package.json') package.json
50+
| includes convenient methods for working with the framework, including compiling code, running tests, and more.
51+
p
52+
| To use our build system and run template locally, you’ll need a copy of CoreUI’s source files and Node. Follow these steps and you should be ready to rock:
53+
ol
54+
li
55+
a(href='https://nodejs.org/en/download/') Download and install Node.js
56+
| , which we use to manage our dependencies.
57+
li
58+
| Either
59+
a(href='https://github.com/coreui/coreui-free-bootstrap-admin-template/archive/v4.0.0.zip') download CoreUI’s sources
60+
| or fork
61+
a(href='https://github.com/coreui/coreui-free-bootstrap-admin-template') CoreUI’s repository
62+
| .
63+
li
64+
| Navigate to the root
65+
code /coreui-free-bootstrap-admin-template
66+
| directory and run
67+
code npm install
68+
| to install our local dependencies listed in
69+
a(href='https://github.com/coreui/coreui-free-bootstrap-admin-template/blob/v4.0.0/package.json') package.json
70+
| .
71+
p
72+
| When completed, you’ll be able to run the various commands provided from the command line.
73+
h2#using-npm-scripts
74+
| Using npm scripts
75+
a.anchorjs-link(aria-label='Anchor' data-anchorjs-icon='#' href='#using-npm-scripts' style='padding-left: 0.375em;')
76+
p
77+
| Our
78+
a(href='https://github.com/coreui/coreui-free-bootstrap-admin-template/blob/v4.0.0/package.json') package.json
79+
| includes numerous tasks for developing the project. Run
80+
code npm run
81+
| to see all the npm scripts in your terminal.
82+
strong Primary tasks include:
83+
table.table
84+
thead
85+
tr
86+
th Task
87+
th Description
88+
tbody
89+
tr
90+
td
91+
code npm start
92+
td
93+
| Compiles CSS and JavaScript, and starts a local server.
94+
tr
95+
td
96+
code npm run build
97+
td
98+
| Creates the
99+
code dist/
100+
| directory with compiled files. Requires
101+
a(href='https://sass-lang.com/') Sass
102+
| ,
103+
a(href='https://github.com/postcss/autoprefixer') Autoprefixer
104+
| , and
105+
a(href='https://github.com/terser/terser') terser
106+
| .
107+
tr
108+
td
109+
code npm run serve
110+
td
111+
| Start a local server for files in dist folder.
112+
113+
h2(class='mt-5') Contents
114+
115+
p
116+
| Within the download you’ll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You’ll see something like this:
117+
pre.hljs
118+
| free-bootstrap-admin-template/
119+
| ├── build/
120+
| ├── src/
121+
| │ ├── assets/
122+
| │ │ ├── brand/
123+
| │ │ ├── favicon/
124+
| │ │ ├── icons/
125+
| │ │ ├── img/
126+
| │ ├── js/
127+
| │ ├── pug/
128+
| │ │ ├── _layout/
129+
| │ │ ├── _partial/
130+
| │ │ ├── base/
131+
| │ │ ├── buttons/
132+
| │ │ ├── icons/
133+
| │ │ ├── notifications/
134+
| │ │ ├── ...
135+
| │ │ ├── index.pug
136+
| │ │ └── ...
137+
| │ ├── scss/
138+
| │ ├── vendors/
139+
| │ └── views/
140+
| │ ├── base/
141+
| │ ├── buttons/
142+
| │ ├── css/
143+
| │ ├── icons/
144+
| │ ├── notifications/
145+
| │ ├── ...
146+
| │ ├── index.html
147+
| │ └── ...
148+
| └── package.json
149+

0 commit comments

Comments
 (0)