Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Thanh Nguyen committed Apr 26, 2023
1 parent 1e37856 commit d9925a1
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 14 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@

DO CMS is a Content Management System targeting developers as its users. Instead of relying on a GUI to create, publish and update website content, these operations are done via developer-friendly tools and flow: Git and CI/CD.

## What's new?

- EMbed [Bootstrap components](https://getbootstrap.com/docs/5.0/components/) to documents:
- `Alerts`: https://getbootstrap.com/docs/5.0/components/alerts/
- `Cards`: https://getbootstrap.com/docs/5.0/components/card/#grid-cards
- `Tabs`: https://getbootstrap.com/docs/5.0/components/navs-tabs/#tabs
- Tags and Tag cloud

## Highlighted features

- **Markdown** is a simple yet powerful markup language for creating formatted text. DO CMS supports [GitHub Flavored Markdown](https://github.github.com/gfm/) as well as extensions such as Mathematical and Chemical formulas.
Expand Down
2 changes: 1 addition & 1 deletion be-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Copyright (C) by **com.github.btnguyen2k**.

Latest release version: `0.1.0`. See [RELEASE-NOTES.md](../RELEASE-NOTES.md).
Latest release version: [RELEASE-NOTES.md](../RELEASE-NOTES.md).

## Getting Started

Expand Down
41 changes: 28 additions & 13 deletions fe/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,39 @@
# fe-tpl-bootstrap
DO CMS Frontend as a VueJS project.

## Structure
- `./src/tpl-bootstrap`: Template `Bootstrap`
- `./src/tpl-coderdocs`: Template `CoderDocs`
- `./src/tpl-prettydocs`: Template `PrettyDocs`
- `./src/_shared`: common assets shared by all template

## Project setup
```
```shell
npm install
```

### Compiles and hot-reloads for development
```
npm run serve
```
## Compiles and hot-reloads for development
```shell
# for template Bootstrap
npm run serve:bootstrap

### Compiles and minifies for production
```
npm run build
```
# for template CoderDocs
npm run serve:coderdocs

### Lints and fixes files
# for template PrettyDocs
npm run serve:prettydocs
```
npm run lint

## Compiles and minifies for production
```shell
# for template Bootstrap, output to dist/tpl-bootstrap
npm run build:bootstrap

# for template CoderDocs, output to dist/tpl-coderdocs
npm run build:coderdocs

# for template PrettyDocs, output to dist/tpl-prettydocs
npm run build:prettydocs
```

### Customize configuration
## Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).

0 comments on commit d9925a1

Please sign in to comment.