mirror of
https://github.com/marktext/marktext.git
synced 2025-05-04 02:30:48 +08:00
162 lines
10 KiB
Markdown
162 lines
10 KiB
Markdown
> **This documentation is outdated, based on the original readme from 14 April 2018!**
|
|
|
|
<p align="center"><img src="../../static/logo-small.png" alt="marktext" width="100" height="100"></p>
|
|
|
|
<h1 align="center">MarkText</h1>
|
|
|
|
<div align="center">
|
|
<a href="https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fmarktext%2Fmarktext">
|
|
<img src="https://img.shields.io/twitter/url/https/github.com/marktext/marktext.svg?style=for-the-badge" alt="twitter">
|
|
</a>
|
|
</div>
|
|
<div align="center">
|
|
<strong>:high_brightness:Edytor markdown nowej generacji:crescent_moon:</strong>
|
|
</div>
|
|
<div align="center">
|
|
Aplikacja na bazie <code>Electron</code> na platformy OS X, Windows i Linux
|
|
</div>
|
|
|
|
<br />
|
|
|
|
<div align="center">
|
|
<!-- Version -->
|
|
<a href="https://marktext.github.io/website">
|
|
<img src="https://badge.fury.io/gh/jocs%2Fmarktext.svg" alt="website">
|
|
</a>
|
|
<!-- License -->
|
|
<a href="https://marktext.github.io/website">
|
|
<img src="https://img.shields.io/github/license/marktext/marktext.svg" alt="LICENSE">
|
|
</a>
|
|
<!-- Build Status -->
|
|
<a href="https://marktext.github.io/website">
|
|
<img src="https://travis-ci.org/marktext/marktext.svg?branch=master" alt="build">
|
|
</a>
|
|
<!-- Downloads total -->
|
|
<a href="https://marktext.github.io/website">
|
|
<img src="https://img.shields.io/github/downloads/marktext/marktext/total.svg" alt="total download">
|
|
</a>
|
|
<!-- Downloads latest release -->
|
|
<a href="https://marktext.github.io/website">
|
|
<img src="https://img.shields.io/github/downloads/marktext/marktext/v0.16.3/total.svg" alt="latest download">
|
|
</a>
|
|
<!-- deps -->
|
|
<a href="https://marktext.github.io/website">
|
|
<img src="https://img.shields.io/hackage-deps/v/lens.svg" alt="dependencies">
|
|
</a>
|
|
<!-- donates -->
|
|
<a href="https://opencollective.com/marktext">
|
|
<img src="https://opencollective.com/marktext/tiers/backer/badge.svg?label=backer&color=brightgreen" alt="donate">
|
|
</a>
|
|
</div>
|
|
|
|
<div align="center">
|
|
<h3>
|
|
<a href="https://marktext.github.io/website">
|
|
Strona
|
|
</a>
|
|
<span> | </span>
|
|
<a href="https://github.com/marktext/marktext#features">
|
|
Cechy programu
|
|
</a>
|
|
<span> | </span>
|
|
<a href="https://github.com/marktext/marktext#download-and-installation">
|
|
Instalacja
|
|
</a>
|
|
<span> | </span>
|
|
<a href="https://github.com/marktext/marktext#development">
|
|
Rozwój
|
|
</a>
|
|
<span> | </span>
|
|
<a href="https://github.com/marktext/marktext#contribution">
|
|
Udział w projekcie
|
|
</a>
|
|
</h3>
|
|
</div>
|
|
|
|
<div align="center">
|
|
<sub>Edytor Markdown, który potrafi. Zbudowany z ❤︎ przez
|
|
<a href="https://github.com/Jocs">Jocs</a> i
|
|
<a href="https://github.com/marktext/marktext/graphs/contributors">
|
|
innych
|
|
</a>
|
|
</sub>
|
|
</div>
|
|
|
|
<br />
|
|
|
|

|
|
|
|
### Cechy programu
|
|
|
|
- Podgląd na żywo - użycie [snabbdom](https://github.com/snabbdom/snabbdom) jako swojego silnika renderującego.
|
|
- Wsparcie specyfikacji [CommonMark](https://spec.commonmark.org/0.29/) i [GitHub Flavored Markdown](https://github.github.com/gfm/).
|
|
- Wsparcie paragrafów i skrótów klawiatowych dla stylów wbudowanych w celu zwiększenia twojej wydajności podczas pisania.
|
|
- Zapis do plików **HTML** i **PDF**.
|
|
- Ciemny i jasny motyw.
|
|
- Różne tryby edycji: **Kod źródłowy**, **Maszyna do pisania**, **Skupienie**.
|
|
|
|
<h4 align="center">:crescent_moon:Motywy:high_brightness:</h4>
|
|
|
|
| Ciemny :crescent_moon: | Jasny :high_brightness: |
|
|
|:------------------------------------------------------------------:|:-------------------------------------------------------------------:|
|
|
|  |  |
|
|
|
|
<h4 align="center">:smile_cat:Tryby edycji:dog:</h4>
|
|
|
|
| Kod źródłowy | Maszyna do pisania | Skupienie |
|
|
|:--------------------------------------------------------------------:|:------------------------------------------------------------------------:|:-------------------------------------------------------------------:|
|
|
|  |  |  |
|
|
|
|
### Dlaczego kolejny edytor?
|
|
|
|
1. Kocham pisać. Używałem wiele różnych edytorów markdown, ale wciąż nie ma takiego, który byłby w pełni zgodny z moimi oczekiwaniami. Nie lubię, kiedy pisanie przerywają mi niemożliwe do wytrzymania błędy. **MarkText** używa wirtualnego DOM do wyrenderowania strony co sprawia, że jest bardzo wydajny. Program jest rozpowszechniany na licencji open source dla wszystkich przyjaciół kochających markdown i pisanie.
|
|
2. Jak już zostało wspomniane powyżej, **MarkText** będzie zawsze rozpowszechniany na licencji open source. Wierzymy, że wszyscy wielbiciele markdown dołożą swoją cegiełkę do kodów źródłowych programu i pomogą w rozwijaniu **MarkText**.
|
|
3. Istnieje wiele edytorów markdown i każdy z nich ma swoje cechy szczególne, jednak ciężko jest zaspokoić wszystkie potrzeby użytkowników. Wierzę, że **MarkText** jest w stanie zaspokoić potrzeby jak największej grupy osób. Mimo iż najnowsza wersja **MarkText** nie jest idealna, próbujemy stworzyć go tak doskonałym jak to jest tylko możliwe.
|
|
|
|
### Instalacja
|
|
|
|

|
|
|
|
|  |  |  |
|
|
|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
|
| [](https://github.com/marktext/marktext/releases/download/v0.16.3/marktext.dmg) | [](https://github.com/marktext/marktext/releases/download/v0.16.3/marktext-setup.exe) | [](https://github.com/marktext/marktext/releases/download/v0.16.3/marktext-x86_64.AppImage) |
|
|
|
|
Nie znalazłeś swojego systemu? Przejdź do strony [release](https://github.com/marktext/marktext/releases). Wciąż nie znalazłeś? Zgłoś [problem](https://github.com/marktext/marktext/issues).
|
|
|
|
Chciałbyś zobaczyć jak nowe udogodnienia wprowadziła najnowsza wersja? Udaj się do [CHANGELOG](../../.github/CHANGELOG.md)
|
|
|
|
Jeśli używasz systemu OS X, to możesz zainstalować MarkText za pomocą [**homebrew cask**](https://github.com/caskroom/homebrew-cask). Aby zacząć korzystać z Homebrew-Cask potrzebujesz tylko [Homebrew](https://brew.sh/).
|
|
|
|
> brew install --cask mark-text
|
|
|
|

|
|
|
|
### Rozwój
|
|
|
|
Jeżeli chciałbyś samodzielnie zbudować **MarkText**:
|
|
|
|
- sklonuj to repozytorium.
|
|
- uruchom komendę `npm install`
|
|
- uruchom komendę `npm run build`
|
|
- skopiuj zbudowaną aplikację do folderu Applications lub jeśli używasz systemu Windows uruchom instalator.
|
|
|
|
W przypadku jakichkolwiek pytań podczas korzystania z **MarkText** zaczęcamy do zgłoszenia problemu. Mamy nadzieję, że będziesz trzymał się ustalonego z góry formatu zgłaszania problemów. Wspaniale by było, jeżeli to właśnie ty naprawisz błąd i zgłosisz pull request.
|
|
|
|
## Udział w projekcie
|
|
|
|
MarkText jest w trakcie rozwijania. Upewnij się, że przeczytałeś [Contributing Guide](../../CONTRIBUTING.md) przed stworzeniem pull request. Chcesz dodać nowe udogodnienia do MarkText? Udaj się do [TODO LIST](../../.github/TODOLIST.md)
|
|
|
|
Dziękujemy wszystkim osobom, które już wzięły udział w projekcie MarkText! Jeżeli już jesteś członkiem [contributors](https://github.com/marktext/marktext/graphs/contributors), otwórz pull request aby dodać twoje imię i zdjęcie do poniższej listy osób, które pomogły przy projekcie.
|
|
|
|
Specjalne podziękowania dla @[Yasujizr](https://github.com/Yasujizr), który zaprojektował logo MarkText.
|
|
|
|
| [](https://github.com/Jocs) | [](https://github.com/ywwhack) | [](https://github.com/notAlaanor) | [](https://github.com/fxha) |
|
|
|:----------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|
|
|
| [Jocs](https://github.com/Jocs) | [ywwhack](https://github.com/ywwhack) | [notAlaanor](https://github.com/notAlaanor) | [fxha](https://github.com/fxha) |
|
|
|
|
### Licencja
|
|
|
|
[**MIT**](../../LICENSE).
|
|
|
|
Copyright (c) 2017-present, @Jocs
|