Skip to content

Commit f626981

Browse files
author
sven
committed
chore(docs) update readme
1 parent d9fba80 commit f626981

File tree

2 files changed

+41
-3
lines changed

2 files changed

+41
-3
lines changed

.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
1-
# Plone Classic Docs
1+
# Plone Classic UI Docs
22

3-
- All documentation shoud be written in Markdown.
4-
- If possibe, please structure into dirs, this will make it easier to build a structure later.
3+
- All documentation should be written in [CommonMark](https://commonmark.org/) Markdown.
4+
- If possible, please structure into dirs, this will make it easier to build a structure later.
5+
6+
See the following example
7+
8+
```markdown
9+
/docs
10+
➜ tree
11+
.
12+
├── deploy.md
13+
├── index.md
14+
└── install.md
15+
```
16+
Use a file called `index.md` for creating a index (if needed)
17+
18+
```shell
19+
➜ cat index.md
20+
install.md
21+
deploy.md
22+
```
523

624
Thank you!!
725

0 commit comments

Comments
 (0)