Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
zhengchun committed Nov 3, 2023
1 parent 5940c09 commit 70d40ab
Showing 1 changed file with 7 additions and 39 deletions.
46 changes: 7 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
Atlassian Design for Bootstrap v5
Awesome Bootstrap Theme Designed with Atlassian Design
===
The most popular Bootstrap UI Kits with Atlassian Design for your next project quickly get you started.
A Beautiful Free Bootstrap theme with fully responsive, powerful CSS utilities, expertly crafted components with Atlassian Design.

[![npm version](https://img.shields.io/npm/v/fastbootstrap)](https://www.npmjs.com/package/fastbootstrap)
[![MIT license](https://img.shields.io/github/license/fastbootstrap/atlassian-design-for-bootstrap)](https://github.com/fastbootstrap/atlassian-design-for-bootstrap/blob/master/LICENSE)
[![](https://data.jsdelivr.com/v1/package/npm/fastbootstrap/badge)](https://www.jsdelivr.com/package/npm/fastbootstrap)

## Quick start

### Install
### Install with NPM

This repository is distributed with npm.

Expand All @@ -23,51 +24,18 @@ After installion, you can building SCSS and JS using this snippet.
npm run dist
```

### CDN
### from CDN

Use a CDN for load compiled JS and CSS from jsdelivr.

https://www.jsdelivr.com/package/npm/fastbootstrap

## Documentation

The documentation included in this repo in the root directory, and is built with [Hugo](https://gohugo.io/).

Browse the online documentation, visit [fastbootstrap.com](https://fastbootstrap.com).

Documentation search is powered by open source [Lunr](https://lunrjs.com/).

### Running documentation locally

```sh
hugo server --port 9001
```

Open `http://localhost:9001/` in your browser now.

## Community

For help, or a feature request:

[Discuss on GitHub](https://github.com/fastbootstrap/atlassian-design-for-bootstrap/discussions)


## Extended Components

The extended components below are ready to your project, it's free forever.

- [Avatar](https://fastbootstrap.com/components/avatar/)
- [Avatar Group](https://fastbootstrap.com/components/avatar-group/)
- [Blankslate](https://fastbootstrap.com/components/blankslate/)
- [Layout](https://fastbootstrap.com/components/layout/)
- [Lozenge](https://fastbootstrap.com/components/lozenge/)
- [Menu](https://fastbootstrap.com/components/menu/)
- [Progress Indicator](https://fastbootstrap.com/components/progress-indicator/)
- [Progress Tracker](https://fastbootstrap.com/components/progress-tracker/)
- [Rating](https://fastbootstrap.com/components/rating/)
- [Side Navigation](https://fastbootstrap.com/components/side-navigation/)
- [Tag](https://fastbootstrap.com/components/tag/)

Browse [all components](https://fastbootstrap.com/components)

## Contributing

Feel free to raise an issue or submit a pull request.

0 comments on commit 70d40ab

Please sign in to comment.