Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
kevin7lou committed Mar 29, 2024
1 parent f84c975 commit eca9268
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 36 deletions.
45 changes: 10 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,20 @@
<h1 align="center">
<img src="https://raw.githubusercontent.com/peaceiris/mkdocs-material-boilerplate/main/docs_sample/images/graduate-cap.png" alt="MkDocs icon" width="170">
<br>MkDocs Material<br>Boilerplate - Starter Kit
<img src="https://raw.githubusercontent.com/kevin7lou/awesome-tm1-planning-analytics/master/docs/images/tm1-pa-logo.png" alt="tm1pa" width="270">
<br>
Awesome TM1 Planning Analytics
</h1>

![Eyecatch image of MkDocs Material Boilerplate (Starter Kit)](https://raw.githubusercontent.com/peaceiris/mkdocs-material-boilerplate/main/docs_sample/images/material.png)



[![license](https://img.shields.io/github/license/peaceiris/mkdocs-material-boilerplate.svg)](https://github.com/peaceiris/mkdocs-material-boilerplate/blob/main/LICENSE)
[![release](https://img.shields.io/github/release/peaceiris/mkdocs-material-boilerplate.svg)](https://github.com/peaceiris/mkdocs-material-boilerplate/releases/latest)
[![GitHub release date](https://img.shields.io/github/release-date/peaceiris/mkdocs-material-boilerplate.svg)](https://github.com/peaceiris/mkdocs-material-boilerplate/releases)
[![GitHub Actions status](https://github.com/peaceiris/mkdocs-material-boilerplate/workflows/github%20pages/badge.svg)](https://github.com/peaceiris/mkdocs-material-boilerplate/actions)

[![Netlify Status](https://api.netlify.com/api/v1/badges/9c95ccf4-5c1e-447b-8025-dd0b6f8764a5/deploy-status)](https://app.netlify.com/sites/mkdocs-material/deploys)

<!-- https://shields.io/ -->



## Details

Read more 👉 [Documentation - MkDocs Material Boilerplate]

[Documentation - MkDocs Material Boilerplate]: https://peaceiris.github.io/mkdocs-material-boilerplate/



## Quick start

```sh
git clone https://github.com/peaceiris/mkdocs-material-boilerplate.git
cd mkdocs-material-boilerplate
pipenv sync --dev
pipenv shell
inv serve --config-file mkdocs.yml
```
<div align="center"><a href="https://github.com/sindresorhus/awesome">
<img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome" border="0">
</a>
</div>
</br>

> Probably the best curated list of TM1 Planning Analytics

## Links

- [MkDocs Material Boilerplate (Starter Kit)](https://github.com/peaceiris/mkdocs-material-boilerplate)
- [mkdocs/mkdocs: Project documentation with Markdown - GitHub]
- [squidfunk/mkdocs-material: A Material Design theme for MkDocs]

Expand Down
File renamed without changes
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Welcome to Awesome TM1 Planning Analytics

<figure markdown="span">
![TM1-PA Logo](assets/images/tm1-pa-logo.png){ width="350" }
![TM1-PA Logo](images/tm1-pa-logo.png){ width="350" }
</figure>

<figure markdown="span">
Expand Down

0 comments on commit eca9268

Please sign in to comment.