picture: image/dropbox_geoblast.jpg tags: [Markdown, Vorlage] date: 2019-03-05
Einige häufig verwendete Markdown-Vorlagen teilen
Markdown hat in unserem täglichen Gebrauch im Grunde andere Textwerkzeuge ersetzt, aber im Gegensatz zu anderen Texteditoren gibt es nicht viele Vorlagen für neue Projekte. Vor ein paar Tagen habe ich auf Dropbox Paper einige Markdown-Vorlagen gesehen, die sehr gut gemacht sind. Ich habe sie zusammengetragen und einige häufig verwendete Markdown-Dokumente hinzugefügt.
Die Vorlagen umfassen:
Zum Schluss füge ich den Quellcode der englischen Dokumente hinzu
Brainstorming
Quellcode
# 💡 Brainstorming: Thema hinzufügen
| **Ziel** | Welche Art von Ideen möchten Sie? |
| --------------- | --------------------------------------- |
| **Teilnehmer** | @erwähnen Sie sich selbst und andere |
| **Verwandt** | - 🔗 [Einige Dokumente oder Links einfügen]() |
## Inspiration
Fügen Sie Bilder, Videos und mehr hinzu, indem Sie die Symbolleiste verwenden, die angezeigt wird, wenn Sie die Eingabetaste drücken
## Ideen
Stellen Sie dem Team eine Frage, um den Prozess in Gang zu bringen
----------
## Nächste Schritte
- [ ] Über den Tellerrand hinausdenken @jemand
- [ ] Von der Aufgabenliste zur Erledigung @jemand
Anzeigeeffekt (Einzug angepasst)
💡 Brainstorming: Thema hinzufügen
Ziel | Welche Art von Ideen möchten Sie? |
---|---|
Teilnehmer | @erwähnen Sie sich selbst und andere |
Verwandt | -Verwandtes Dokument 1 <br> - Verwandtes Dokument einfügen |
Inspiration
Fügen Sie Bilder, Videos und mehr hinzu, indem Sie die Symbolleiste verwenden, die angezeigt wird, wenn Sie die Eingabetaste drücken
Ideen
Stellen Sie dem Team eine Frage, um den Prozess in Gang zu bringen
Nächste Schritte
- [ ] Über den Tellerrand hinausdenken @jemand
- [ ] Von der Aufgabenliste zur Erledigung @jemand
Sitzungsprotokoll
Quellcode
# 🕘 Sitzungsprotokoll: Ereignisname hinzufügen
# 2019-03-02
****
## Teilnehmer
@erwähnen Sie sich selbst und fügen Sie andere hinzu
## Tagesordnung
- Sitzungsagenda
## Diskussion
- Was wir tatsächlich besprochen haben
## Aufgaben
- [ ] Wir erledigen diese Aufgabe @jemand
Anzeigeeffekt (Einzug angepasst)
🕘 Sitzungsprotokoll: Ereignisname hinzufügen
2019-03-02
Teilnehmer
@erwähnen Sie sich selbst und fügen Sie andere hinzu
Tagesordnung
- Sitzungsagenda
Diskussion
- Was wir tatsächlich besprochen haben
Aufgaben
- [ ] Wir erledigen diese Aufgabe @jemand
Projektplan
# 📋 Projektplan: Projekt hinzufügen
| **Beschreibung** | Was haben Sie im Sinn? |
| ---------------- | --------------------------------------- |
| **Status** | Früh 🌱 | In Bearbeitung 🔨 | Fertig ⭐ |
| **Team** | Rolle: @jemand<br>Rolle: @jemand |
| **Verwandt** | - [Verwandtes Dokument 1](document1) <br>- [Verwandtes Dokument einfügen](http://document) |
## Zeitachse
| Titel | Datum (Deadline) | Zugewiesen an | Beschreibung |
| ----- | :--------------: | ------------- | ------------ |
| | 03.01-03.12 | | |
## Details
Fügen Sie Bilder, Videos und mehr hinzu, indem Sie die Symbolleiste verwenden, die angezeigt wird, wenn Sie die Eingabetaste drücken
## Aufgabenliste
- [ ] Wir werden diese Aufgabe erledigen @jemand
- [ ] Wir lösen diese Aufgabe heute @jemand
Anzeigeeffekt (Einzug angepasst)
📋 Projektplan: Projekt hinzufügen
Beschreibung | Was haben Sie im Sinn? |
---|---|
Status | Früh 🌱 |
Team | Rolle: @jemand<br> Rolle: @jemand |
Verwandt | -Verwandtes Dokument 1 <br> - Verwandtes Dokument einfügen |
Zeitachse
Titel | Datum | Zugewiesen an | Beschreibung |
---|---|---|---|
03.01-03.12 |
Details
Fügen Sie Bilder, Videos und mehr hinzu, indem Sie die Symbolleiste verwenden, die angezeigt wird, wenn Sie die Eingabetaste drücken
Aufgabenliste
- [ ] Wir werden diese Aufgabe erledigen @jemand
- [ ] Wir lösen diese Aufgabe heute @jemand
RestAPI-Dokumentation
### Der Titel Ihrer REST-API
Eine Beschreibung Ihrer API
**Methode:** POST
**Content-Type:** application/json
**Endpunkt**
```bash
https://apis.example.com/v1/example
Anforderungskörper-Payload
Property Name | Typ | Beschreibung |
---|---|---|
name | string | der Name dieses Modells |
admin | boolean | Ob das Modell Admin ist |
Antwort-Payload
Property Name | Typ | Beschreibung |
---|---|---|
id | string | die ID des Servers |
name | string | der Name dieses Modells |
admin | boolean | Ob das Modell Admin ist |
Beispielanforderung
curl 'https://apis.example.com/v1/example' \
-H 'Content-Type: application/json' \
-H 'Authorization: ${TOKEN}' \
-d \
'{
"name": "test",
"admin": true
}'
Im obigen Beispiel würden Sie ${TOKEN}
durch das generierte Auth-Token ersetzen, siehe: Benutzerautorisierung.
Eine erfolgreiche Anforderung wird durch einen HTTP-Statuscode 200 OK
angezeigt. Die Antwort enthält die ID Ihres Modells
Beispielantwort
{
"id": "A163D1C8AA1FD43CAF521B74FC5A46BE",
"name": "test",
"admin": "true",
"expiresIn": "3600"
}
Häufige Fehlercodes
invalid_argument
: der [name] könnte für die Datenbank zu lang seinpermission_denied
: Sie haben möglicherweise keine Berechtigung für diese Operation
Andere Fehler, die Sie möglicherweise auf den globalen Fehlercode verweisen müssen.
**Anzeigeeffekt** (Einzug angepasst)
### Der Titel Ihrer REST-API
Eine Beschreibung Ihrer API
**Methode:** POST
**Content-Type:** application/json
**Endpunkt**
```bash
https://apis.example.com/v1/example
Anforderungskörper-Payload
Property Name | Typ | Beschreibung |
---|---|---|
name | string | der Name dieses Modells |
admin | boolean | Ob das Modell Admin ist |
Antwort-Payload
Property Name | Typ | Beschreibung |
---|---|---|
id | string | die ID des Servers |
name | string | der Name dieses Modells |
admin | boolean | Ob das Modell Admin ist |
Beispielanforderung
curl 'https://apis.example.com/v1/example' \
-H 'Content-Type: application/json' \
-H 'Authorization: ${TOKEN}' \
-d \
'{
"name": "test",
"admin": true
}'
Im obigen Beispiel würden Sie ${TOKEN}
durch das generierte Auth-Token ersetzen, siehe: Benutzerautorisierung.
Eine erfolgreiche Anforderung wird durch einen HTTP-Statuscode 200 OK
angezeigt. Die Antwort enthält die ID Ihres Modells
Beispielantwort
{
"id": "A163D1C8AA1FD43CAF521B74FC5A46BE",
"name": "test",
"admin": "true",
"expiresIn": "3600"
}
Häufige Fehlercodes
invalid_argument
: der [name] könnte für die Datenbank zu lang seinpermission_denied
: Sie haben möglicherweise keine Berechtigung für diese Operation
Andere Fehler, die Sie möglicherweise auf den globalen Fehlercode verweisen müssen.
Englischer Quellcode
Brainstorming
# 💡 Brainstorming: Add a topic
| **Goal** | What kinds of ideas do you want? |
| ---------------- | ----------------------------------- |
| **Participants** | @mention yourself and others |
| **Related** | - + (some Related documents ) |
## Inspiration
Add images, videos, and more by using the toolbar that appears when you hit return
## Ideas
Ask the group a question to get things flowing
----------
## Next steps
[ ] Think outside the box @someone
[ ] From to do to done @someone
Projektplan
# 📋 Project plan: Add a project
| **Description** | What do you have in mind? |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| **Status** | Early 🌱 | In progress 🔨 | Finished ⭐ |
| **Team** | Role: @someone<br>Role: @someone |
| **Related** | - [document1](document1.md) <br>- [document2](http://document2.md) |
## Timeline
Title | Dates | Assigned to | Description
--- | --- | --- | ---
| March 1, 2019 - March 6, 2019 | |
## Details
Add images, videos, and more by using the toolbar that appears when you hit return
## To-dos
[ ] We’ll get this done @someone
[ ] Let’s tackle this today @someone
Sitzungsprotokoll
# 🕘 Meeting notes: Add an event name
# Mar 2, 2019
****
## Attendees
@mention yourself and add others
## Agenda
- Stuff to talk about
## Discussion
- Stuff we actually talked about
## Action items
[ ] Let’s get this done @someone
REST API Vorlagen
### The title of your rest api
Some description of your api
**Method:** POST
**Content-Type:** application/json
**Endpoint**
```bash
https://apis.example.com/v1/example
Request Body Payload
Property Name | Type | Description |
---|---|---|
name | string | the name of this model |
admin | boolean | Whether the model is admin |
Response Payload
Property Name | Type | Description |
---|---|---|
id | string | the id of the server |
name | string | the name of this model |
admin | boolean | Whether the model is admin |
Sample request
curl 'https://apis.example.com/v1/example' \
-H 'Content-Type: application/json' \
-H 'Authorization: ${TOKEN}' \
-d \
'{
"name": "test",
"admin": true
}'
In the example above, you would replace ${TOKEN}
with the generated Auth token, Refer: User Authorization .
A successful request is indicated by a 200 OK
HTTP status code. The response contains id of your model
Sample response
{
"id": "A163D1C8AA1FD43CAF521B74FC5A46BE",
"name": "test",
"admin": "true",
"expiresIn": "3600"
}
Common error codes
invalid_argument
: the [name] may be tool long for databasepermission_denied
: you may have no permission for this operation
Other errors you may need to refer to the global error code.