### README (README.md)

# FSNotes

[简体中文](README_zh_CN.md)
[繁體中文](README_zh_TW.md)

FSNotes is modern notes manager for macOS and iOS.

## macOS app

<a href="https://itunes.apple.com/app/fsnotes/id1277179284">
	<img src="https://fsnot.es/img/badge-download-on-the-mac-app-store.svg" alt="">
</a>

<img src="https://fsnot.es/img/fsnotes7/FSNotes7_macOS_Dark.webp?v=2" alt="macOS FSNotes" style="max-width:100%;">

### Key features

- **Markdown-first**. Also supports any plaintext files.
- **Fast and lightweight**. Works smoothly with 10k+ files.
- **Access anywhere**. Sync with iCloud Drive or Dropbox.
- **Multi-folder** storage.
- **Keyboard-centric**.  
- **Syntax highlighting** within code blocks. Supports over 30 programming languages.
- **In-line image** support.
- Organize with **tags**.
- **Cross-note links** using `[[double brackets]]`.
- **Elastic two-pane view**.
- **External editor** support (changes seamless live sync with UI).
- **Pin** important notes.
- **Quickly copy notes** to the clipboard.
- **Dark mode**.
- AES-256 **encryption**.
- **Mermaid and MathJax** support.
- Optional **Git versioning** and **backups**.

---

## iOS app

<a href="https://itunes.apple.com/app/fsnotes-manager/id1346501102">
	<img src="https://fsnot.es/img/badge-download-on-the-app-store.svg" alt="">
</a>

<img width="300" alt="FSNotes for iOS" src="https://fsnot.es/img/fsnotes7/FSNotes7_iOS.webp?v=2"> <img width="300" alt="FSNotes for iOS" src="https://fsnot.es/img/fsnotes7/FSNotes7_iOS_Dark.webp?v=2">

### Key features

- **Sync via iCloud Drive**.
- **3D Touch** and **configurable keyboard**.
- **TextBundle** and **EncryptedTextBundle** containers.
- **Pinned** notes kept in sync with the desktop app.
- **Dynamic fonts**.
- **Dark mode**.
- **Sharing** extension.
- **Encrypted note** support.
- **Encrypted folders** support.
- **Git** integration.
- **Web Pages** Creation.

## License

FSNotes is written in **Swift 5** and is open source (MIT license).

---

### CODE OF CONDUCT (CODE_OF_CONDUCT.md)

# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
 advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
 address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
 professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at fluder (at) icloud (dot) com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

---

### README Zh TW (README_zh_TW.md)

# FSNotes

[English](README.md)
[简体中文](README_zh_CN.md)

FSNotes是一款適用於 macOS 和 iOS 的現代筆記管理器。

## macOS 應用程式

<a href="https://itunes.apple.com/app/fsnotes/id1277179284">
	<img src="https://fsnot.es/img/badge-download-on-the-mac-app-store.svg" alt="">
</a>

<img src="https://raw.githubusercontent.com/glushchenko/fsnotes/master/code.png" alt="macOS FSNotes" style="max-width:100%;">

### 主要功能

- **Markdown 优先**。也支持任何纯文本文件。
- **快速且輕量**。能夠流暢處理 10k+ 個文件。
- **隨時隨地訪問**。與 iCloud Drive 或 Dropbox 同步。
- **多資料夾**存儲。
- **鍵盤為中心**。受 [nvalt](https://brettterpstra.com/projects/nvalt/) 啟發的控件和快捷鍵。
- **程式碼塊內語法高亮**。支持超過 170 種編程語言。
- **內嵌圖片**支持。
- 使用**標籤**進行組織。
- 使用 `[[雙括號]]` 進行**跨筆記鏈接**。
- **彈性兩窗格視圖**。選擇垂直或水平佈局。
- 支持**外部編輯器**（更改會與 UI 實時同步）。
- **置頂**重要筆記。
- **快速複製筆記**到剪貼板。
- **暗黑模式**。
- AES-256 **加密**。
- **Mermaid 和 MathJax** 支持。
- 可選的**Git 版本控制**和**備份**。

---

## iOS 應用程式

<a href="https://itunes.apple.com/app/fsnotes-manager/id1346501102">
	<img src="https://fsnot.es/img/badge-download-on-the-app-store.svg" alt="">
</a>

<img width="300" alt="FSNotes for iOS" src="https://fsnot.es/img/fsnotes6-ios/s1x.webp?v=1.0"> <img width="300" alt="FSNotes for iOS" src="https://fsnot.es/img/fsnotes6-ios/s2x.webp?v=1.0">

### 主要功能

- 通過 iCloud Drive 進行**同步**。
- **3D Touch** 和**可配置鍵盤**。
- **TextBundle** 和 **EncryptedTextBundle** 容器。
- 保持與桌面應用同步的**置頂**筆記。
- **動態字體**。
- **暗黑模式**。
- **分享**擴展。
- **加密筆記**支持。
- **加密資料夾**支持。
- **Git** 集成。
- **網頁**創建。

## 許可證

FSNotes 使用 **Swift 5** 編寫，採用 MIT 許可證開源。

## 特別鳴謝

@zcohan（https://soulver.app）提供了 Soulver 核心框架 https://github.com/soulverteam/SoulverCore，用於簡單的內嵌計算。

---

### .Swiftlint.Yml (.swiftlint.yml)

included: # paths to include during linting. `--path` is ignored if present.
  - FSNotesCore
excluded: # paths to ignore during linting. Takes precedence over `included`.
  - Pods

line_length:
  warning: 220

disabled_rules: 
  - implicit_getter
  - identifier_name

cyclomatic_complexity: 20
function_body_length: 100
file_length: 1000

---

### .Travis.Yml (.travis.yml)

language: swift
os: osx
osx_image: xcode11.5
xcode_workspace: FSNotes.xcworkspace

before_install:
    - pod install --repo-update

env:
    - SCHEME=FSNotes SDK=macosx
    - SCHEME="FSNotes iOS" SDK=iphonesimulator

script: xcodebuild -workspace FSNotes.xcworkspace -scheme "$SCHEME" build -sdk $SDK ONLY_ACTIVE_ARCH=NO -UseModernBuildSystem=NO -quiet

branches:
    only: [master]

---