mirror of
https://github.com/anyproto/docs.git
synced 2025-06-08 05:47:05 +09:00
added the media steps to CONTRIBUTING.md
This commit is contained in:
parent
836054781e
commit
d4506311cd
1 changed files with 35 additions and 0 deletions
|
@ -12,6 +12,7 @@
|
||||||
- [**Text Formats**](#text-formats)
|
- [**Text Formats**](#text-formats)
|
||||||
- [**Lists**](#lists)
|
- [**Lists**](#lists)
|
||||||
- [**Blocks**](#blocks)
|
- [**Blocks**](#blocks)
|
||||||
|
- [**Media**](#media)
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
@ -185,3 +186,37 @@
|
||||||
<img src="https://raw.githubusercontent.com/anytypeio/community/main/assets/danger-hint-block.png" alt="danger-hints">
|
<img src="https://raw.githubusercontent.com/anytypeio/community/main/assets/danger-hint-block.png" alt="danger-hints">
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
### Media
|
||||||
|
|
||||||
|
- **Block :** To create a Media Block you need to use the below convention
|
||||||
|
```
|
||||||
|

|
||||||
|
|
||||||
|
E.g:
|
||||||
|
|
||||||
|

|
||||||
|
```
|
||||||
|
|
||||||
|
- **File Storage :** Any media that is being used has to be uploaded to the  folder only then can it be used inside the documentation.
|
||||||
|
|
||||||
|
- **File Formats :** These are the only file formats that are accepted for uploading media in the documentation.
|
||||||
|
- **Videos :**
|
||||||
|
|
||||||
|
> ✔️ Use only **Mp4**
|
||||||
|
> ❌ No **gifs** or other formats
|
||||||
|
|
||||||
|
- **Images :**
|
||||||
|
|
||||||
|
> ✔️ Use only **PNG** and **SVG** images
|
||||||
|
> ❌ No other formats
|
||||||
|
|
||||||
|
- **Size Limits :** To not have performance issues or slow page loading times there is size limit of **5 MegaBytes** for each media file being used.
|
||||||
|
|
||||||
|
- **Naming :** To reduce confusion, when uploading please rename your files in the proper format
|
||||||
|
```
|
||||||
|
<image-caption>-<page>.<file-format>
|
||||||
|
|
||||||
|
E.g:
|
||||||
|
✔️ loadingscreen-intro.png
|
||||||
|
❌ Screenshot 2021-11-05 at 18.45.31.png
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue