GettingStarted

🥪 tiddler size 0.07 KB 

project-license Netlify Status

011 012 013

Intro 🎉

A modern style notebook based on tiddlywiki. @oeyoews

Here is a » demo «

Intro 🤖

NEOTW is a concise and efficient article publishing platform. We support bilingual publishing in both Chinese and English, and provide a toggle between reading mode and editing mode, so that you can easily edit while reading articles. We also support emoji syntax, allowing you to add more expressions and emotional color to your articles. You can switch between different layouts through the URL, making your reading experience more flexible. In addition, we automatically switch between night/day mode based on the system, and you can also switch modes through the URL. We also support Zen mode, allowing you to enjoy reading in a quiet environment. On NEOTW, you can publish your own articles and comment on others' articles. We automatically display recently created articles, keeping you up to date with the latest news on the platform. To make your reading more beautiful, we also support automatic spacing between Chinese and English, making your typesetting more neat and beautiful. Additionally, we support title aliases to make your titles more exquisite. Welcome to NEOTW, let's enjoy the joy of reading and sharing together! @Chatgpt

This is a document created using TiddlyWiki, which can be opened using TiddlyWiki 5.2.6 or higher. Its main purpose is to introduce Neotw, which includes custom CSS and some plugins that can be used to enhance the appearance and functionality of TiddlyWiki. The document provides detailed instructions on how to install and use the Neotw, as well as how to customize settings and add plugins. Additionally, the document offers some common questions and useful links regarding TiddlyWiki. If you are interested in customizing TiddlyWiki themes and developing plugins, you may find useful information within the TiddlyWiki community. @Chatgpt

Features ✨

  • 随机展示文章
  • 支持 F 全屏, s 切换全屏
  • 文章标题支持中英双语言切换
  • 支持阅读模式编辑模式之间的切换
  • 支持 emoji 语法
  • 支持通过 url 切换多种布局
  • 根据系统自动切换夜间/日间模式, 支持 url 切换,例如 https://neotw.oeyoewl.top?mode=dark
  • 支持禅模式
  • 支持评论
  • 自动展示最近创建的文章
  • 中英文之间自动添加空格,排版更美观
  • 标题支持别名
  • ...

Warning Neotw 部分功能暂时还未单独做成插件,或者部分功能依赖与其他插件, 不建议单独使用

Installation 📦

Note require git and npm and not compatible vanilla theme

不建议使用 root-tiddler 参数(虽然使用有很多好处)

git clone --depth 1 https://github.com/oeyoews/neotw
cd neotw && npm install  # install packages
npm run start  # start tiddlywiki on https://localhost:8099

Deploy ⚙️

Deploy with Vercel

FileStruct 📂

FileStruct
Neotw
├──📁archive
├──📁CITATION.cff
├──📁subwiki
├──📁dist
├──📁files
├──📁img
├──📁LICENSE
├──📁makefile
├──📁netlify.toml
├──📁node_modules
├──📁output
├──📁package.json
├──📁patch
├──📁README.md
├──📁scripts
├──📁src
├──📁static
├──📁templates
├──📁test
├──📁tiddlers
├──📁tiddlywiki.info
├──📁vercel.json
└──📁yarn.lock
# This structure may not be up to date

Online Preview 👀

Preview

TODO

  • 提供 neotw 空白版本
  • 使用 q 关闭打开的 modal

Repobeats

repobeats

cat↥︎
This readme file was automatically generated by Neotw.