bokuchi

(★ 98)

A lightweight, cross-platform Markdown editor

File Explorer

Download Latest Version (.zip)

- - 1-bug-report.yml
  - 2-feature-request.yml
  - 3-other.yml
  - config.yml
- - auto-merge-dependabot.yml
  - dependabot-test.yml
  - issue-labeler.yml
  - release-linux.yml
  - security-audit.yml
  - tauri-update-monitor.yml
  - unit-tests.yml
- dependabot.yml
- pull_request_template.md
- extensions.json
- build-macos-notarized.sh
- build-macos-signed.sh
- build-macos.sh
- build-windows.sh
- check-notarization.sh
- notarize.sh
- - CROSS_COMPILE_TROUBLESHOOTING.md
  - MACOS_NOTARIZATION_GUIDE.md
  - MENU_SYSTEM_GUIDE.md
  - MONKEY_TEST_CASE.md
  - README.md
  - SECURITY.md
  - TESTING.md
  - VERSION_UPDATE_CHECKLIST.md
- CROSS_COMPILE_TROUBLESHOOTING.md
- DEVELOPMENT.md
- MACOS_NOTARIZATION_GUIDE.md
- MENU_SYSTEM_GUIDE.md
- MONKEY_TEST_CASE.md
- README.md
- SECURITY.md
- TESTING.md
- VERSION_UPDATE_CHECKLIST.md
- bokuchi-icon.png
- tauri.svg
- vite.svg
- generate-latest-json.js
- get-port.js
- tauri-dev.js
- verify-release-build.sh
- verify-updater-signing-key.sh
- - App.test.tsx
- - desktopApi.ts
  - fontApi.ts
  - storeApi.ts
  - updaterApi.ts
  - variableApi.ts
- - AppContent.tsx
  - AppDialogs.tsx
  - AppHeader.tsx
  - Editor.tsx
  - EmptyState.tsx
  - FileChangeDialog.tsx
  - FolderTreePanel.tsx
  - Help.tsx
  - InlineCellEditor.tsx
  - KonamiUnlockOverlay.tsx
  - MarkdownToolbar.tsx
  - MarpPreview.tsx
  - MilestoneDialog.tsx
  - OutlinePanel.tsx
  - Preview.tsx
  - RecentFilesDialog.tsx
  - RenameDialog.tsx
  - RenderingFeatureNotice.tsx
  - RinControls.tsx
  - SaveBeforeCloseDialog.tsx
  - SearchReplacePanel.tsx
  - Settings.tsx
  - StatusBar.tsx
  - TabBar.tsx
  - TableConversionDialog.tsx
  - TableEditModal.tsx
  - TypingGame.css
  - TypingGame.tsx
  - UpdateDialog.tsx
  - WhatsNewDialog.tsx
- - dragConfig.ts
- - languages.ts
  - layout.ts
  - zoom.ts
- - useAppState.ts
  - useAutoSave.ts
  - useDesktopEventListeners.ts
  - useEasterEggs.ts
  - useEditorFocus.ts
  - useFileChangeDetection.ts
  - useFileOperations.ts
  - useFolderTree.ts
  - useGameTrigger.ts
  - useKeyboardShortcuts.ts
  - useKonamiCode.ts
  - useMilestone.ts
  - useOutlineHeadings.ts
  - useResizableSidebar.ts
  - useRinExitButton.ts
  - useSettings.ts
  - useTabsDesktop.ts
  - useUpdateChecker.ts
  - useWhatsNew.ts
  - useZoom.ts
- - ar.json
  - de.json
  - en.json
  - es.json
  - fr.json
  - hi.json
  - id.json
  - ja.json
  - ko.json
  - pt-BR.json
  - ru.json
  - vi.json
  - zh-CN.json
  - zh-Hant.json
- - tabReducer.ts
- - base.css
  - markdown.css
  - syntax.css
  - variables.css
- - setup.ts
- - customTheme.ts
  - index.ts
- - folderTree.ts
  - outline.ts
  - recentFiles.ts
  - settings.ts
  - settingsFocus.ts
  - tab.ts
- - cjkEmphasis.ts
  - codeRegions.ts
  - colorUtils.ts
  - editingContext.ts
  - editorStatus.ts
  - editorSync.ts
  - exportStyles.ts
  - fileChangeDetection.ts
  - fileDropFilters.ts
  - folderTreeUtils.ts
  - fontFamily.ts
  - formatters.ts
  - gaiaThemeFonts.ts
  - headingExtractor.ts
  - imageInsertion.ts
  - imagePathResolver.ts
  - katexExportCss.ts
  - listEditorActions.ts
  - listFormatter.ts
  - markdownRenderers.ts
  - markdownToolbarActions.ts
  - marpImageInliner.ts
  - marpRenderer.ts
  - marpSlideRanges.ts
  - marpThemeFolder.ts
  - marpThemeLoader.ts
  - pasteClassifier.ts
  - pathUtils.ts
  - platform.ts
  - registerEditorActions.ts
  - sanitizeHtml.ts
  - searchMatches.ts
  - tableConverter.ts
  - tableEditorActions.ts
  - tableFormatter.ts
  - viewModeUtils.ts
  - wordCount.ts
  - zoomCalculations.ts
- App.tsx
- i18n.ts
- main.tsx
- milestone.ts
- setupMonaco.ts
- test-utils.ts
- vite-env.d.ts
- whatsNew.ts
- - default.json
- - bokuchi-icon.bmp
  - bokuchi-icon.png
  - bokuchi-icon_128x128.bmp
  - bokuchi-icon_128x128.png
  - bokuchi-icon_128x128@2x.png
  - bokuchi-icon_32x32.png
  - bokuchi.icns
  - bokuchi.ico
  - Square107x107Logo.png
  - Square142x142Logo.png
  - Square150x150Logo.png
  - Square284x284Logo.png
  - Square30x30Logo.png
  - Square310x310Logo.png
  - Square44x44Logo.png
  - Square71x71Logo.png
  - Square89x89Logo.png
  - StoreLogo.png
- - commands.rs
  - file_association.rs
  - file_operations.rs
  - lib.rs
  - main.rs
  - pdf_export.rs
  - tests.rs
  - types.rs
  - variable_processor.rs
- - installer.nsi
- .gitignore
- build.rs
- Cargo.lock
- Cargo.toml
- entitlements.plist
- tauri.conf.json
- - fileOperations.spec.ts
.audit-ci.json
.gitignore
CHANGELOG.md
eslint.config.js
index.html
LICENSE
package-lock.json
package.json
README.md
tsconfig.json
tsconfig.node.json
vite.config.ts
vitest.config.ts
wdio.conf.ts

# Installation Guide

1. Get the code

git clone https://github.com/Bokuchi-Editor/bokuchi

Downloads the entire project code from GitHub to your computer.

cd bokuchi

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm run tauri:dev

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

3. Rust

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cd src-tauri

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

bokuchi

File Explorer

# Installation Guide

2. Node.js

3. Rust

Today's picks

Was this content helpful?

Recent Feedback

bokuchi

File Explorer

# Installation Guide

2. Node.js

3. Rust

Today's picks

Was this content helpful?

Recent Feedback

Download README