Skip to content

AndersonHJB/CodeMark

Repository files navigation

CodeMark🦭

CodeMark 结合了 CodeMarkdown 的特点,目标是让用户可以在浏览器中更轻量地编写、运行、管理和分享代码。

它尤其适合教学、作业、课堂演示和代码片段分享:学生不需要一开始就配置完整本地环境,也可以先在线运行 Python 代码,观察输出结果,再逐步迁移到本地开发。

如果你热衷于开源,或者想一起加入这个富有意义的项目,可以与我联系。

诚邀 Python、Web!!! 精通的伙伴~

CodeMark交流群

项目定位🎯

CodeMark 不是为了替代专业 IDE,而是为了降低编程学习和代码分享的起步门槛。

  • 对学生:减少环境安装带来的挫败感,先把注意力放在代码逻辑和运行结果上。
  • 对老师:可以更方便地布置、展示、分享和讲解代码片段。
  • 对内容创作者:可以把代码、说明、运行效果和分享链接组织到一个更易传播的页面中。
  • 对自学者:可以快速验证想法,保存代码片段,并通过链接继续交流。

核心功能✨

  • 在线代码编辑:在浏览器中直接编写代码。
  • Python 运行:通过 Pyodide 支持浏览器端 Python 运行体验。
  • 代码分享:生成可访问的分享链接和二维码。
  • 项目文件侧边栏:支持多文件、文件夹、上传、下载、重命名、删除和选择操作。
  • 资源预览:支持图片等资源文件的导入与预览。
  • 纯分享模式:可以只分享代码项目,不启用运行功能。
  • 移动端适配:在移动设备上保留基础编辑、分享和文件管理入口。

Logo 寓意💡

CodeMark OK Logo

CodeMark 侧边栏左上角使用 OK 作为轻量级工作区入口标识,表达“项目已就绪,可以开始编写、管理和分享代码”的状态感。

  • O:代表代码项目、文件集合与学习闭环,寓意用户可以在一个完整的工作区中组织代码。
  • K:代表 Code、Keyboard 与 Knowledge,强调编写代码、动手实践和知识沉淀。
  • OK:整体传达“可用、确认、准备就绪”的含义,让用户进入编辑器时能快速理解当前工作区处于可操作状态。

这个 Logo 在页面中不是复杂的品牌主视觉,而是一个清晰的功能入口:点击它,可以展开或折叠项目文件侧边栏,帮助用户管理多个文件、文件夹和代码资源。

使用场景🎬

  1. 教学文档:老师可以把代码示例和说明结合起来,便于课堂演示。
  2. 作业文档:学生可以在线完成代码题目,并通过链接提交或交流。
  3. 高校课程:适合用于编程作业布置、代码片段分享和课堂互动。
  4. 代码演示:适合快速展示一个 Python 示例、算法片段或实验思路。
  5. 学习记录:适合保存多个文件组成的小型代码项目。

页面说明🧭

  • /editor:可运行的 Python 在线编辑器,适合边写边运行。
  • /sharecode:纯代码分享与多文件项目展示页面,适合不需要运行的代码分享。
  • /share/<project_id>:分享链接页面,根据分享类型进入运行模式或纯分享模式。

项目依赖开🖲️

主要 Python 依赖可查看 requirements.txt,其中包含 Flask、Markdown、Pillow、qrcode 等运行所需组件。

本地运行🚀

建议使用虚拟环境运行项目:

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python app.py

如果使用 Flask 命令运行:

python -m flask --app app run

维护命令⚙️

导出依赖:

pip freeze > requirements.txt

服务端部署脚本请根据实际服务器路径调整,避免直接复用本地或旧服务器的绝对路径。

声明🖨️

本项目全权由 AI悦创维护。如果想要拿去当作毕业设计、课设等,请及时联系与我沟通,严禁商用。

CodeMark is licensed under the GNU General Public License (GPL) Version 3. See the LICENSE file for more details.

作者✍️&请我喝咖啡☕️

img_1.png

关于 CodeMark

CodeMark 是由 黄家宝|Bornforthis 创建并维护的开源项目。使用本项目即表示你同意 GNU General Public License (GPL) Version 3 的相关条款。

任何基于 CodeMark 的修改或衍生项目,也应遵循 GNU GPL 的开源协议要求。

如何参与贡献

欢迎提交功能改进、问题修复、文档优化和使用反馈。参与贡献即表示你的贡献内容将遵循与原项目相同的开源协议。

About

结合“Code”和“Markdown”的特点,用户可以在 Markdown 中编写并执行代码的功能

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors