Skip to content

Commit 103c9f7

Browse files
committed
update docs
1 parent 83f7374 commit 103c9f7

12 files changed

Lines changed: 569 additions & 401 deletions

README.md

Lines changed: 23 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,30 @@
66
[![Total Downloads](https://img.shields.io/packagist/dt/solution-forest/inspirecms-core.svg?style=flat-square)](https://packagist.org/packages/solution-forest/inspirecms-core)
77

88

9+
InspireCMS Core is the foundation library that powers the InspireCMS platform. This package provides essential functionality, including content management, admin interfaces, and extensibility features. Designed with flexibility and developer experience in mind, it allows you to quickly build customized content management systems for your Laravel applications.
10+
11+
## Table of Contents
12+
- [Get Started]()
13+
- [Overview](./docs/Overview.md)
14+
- [Requirements](./docs/Requirements.md)
15+
- [Installing](./docs/Installing.md)
16+
- [Updating](./docs/Updating.md)
17+
- [CONTRIBUTING](.github/CONTRIBUTING.md)
18+
- [Core]()
19+
- [Overview](./docs/CoreConcepts.md)
20+
- [Configuration](Configuration.md)
21+
- [Templating](./docs/Templating.md)
22+
- [Navigation](./docs/Navigation.md)
23+
- [Resources]()
24+
- [Tips](./docs/Tips.md)
25+
- [Fields](./docs/CustomFields.md)
26+
- [Addons](./docs/Addons.md)
27+
- [Reference]()
28+
- [Content](./docs/references/Content.md)
29+
- [DocumentType](./docs/references/DocumentType.md)
30+
- [Template](./docs/references/Template.md)
31+
- [Available Services](./docs/references/Services.md)
932

10-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
11-
12-
## Development
13-
### Install inspirecms-support library
14-
`COMPOSER_ROOT_VERSION=dev-main composer update`
15-
16-
### Build js and css
17-
18-
1. Install composer dependencies:
19-
```bash
20-
composer install
21-
```
22-
23-
2. Install npm dependencies:
24-
```bash
25-
npm i
26-
```
27-
28-
3. Build assets:
29-
```bash
30-
npm run build
31-
```
32-
33-
## Documentation
34-
35-
For additional documentation, please see [Document](./docs/Documentation.md).
3633

3734
## Testing
3835

@@ -44,10 +41,6 @@ composer test
4441

4542
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
4643

47-
## Contributing
48-
49-
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
50-
5144
## Security Vulnerabilities
5245

5346
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

0 commit comments

Comments
 (0)