/Notes

GNU General Public License v2.0GPL-2.0

欢迎来到笔记库

Hi,我们来自长三角各地,年龄相仿,是一群高中生或马上就要成为高中生的孩子。

学习的过程中我们发现了线性学习与知识网状关联的问题,在学习的过程中,我们了解到了Obsidian这款优秀的知识管理工具、MarkdownLaTeX两款强大的记录及排版语言。我们希望用MarkdownLaTeX记下我们所学的知识,并通过Obsidian进行网格式管理,就像这样 ↓ Obsidian使用示例

目录:

粗略地了解一下下面的内容吧!

Markdown

大部分内容来自Markdown 中文网

Markdown 是一种简单易用的标记语言,由 John Gruber 设计,您可以使用它来格式化几乎任何文档。

基本语法:

几乎所有 Markdown 应用程序(如上面提到的ObsidianMicrosoft Visual Studio CodeTyporaMarkText)都支持 John Gruber 原始设计文档中概述的基本语法,而且渲染样式基本相同
Tip:

您可以将 HTML 标签添加到任何 Markdown 文件中。如果您更喜欢某些 HTML 标记而不是 Markdown 语法,这将很有帮助。例如,有些人发现将 HTML 标签用于图像更容易。

扩展语法:

John Gruber 的原始设计文档中概述的基本语法每天增加了许多所需的元素,有时候我们会发现这还不够(比如当你需要键入一些奇怪的化学符号的时候)。这就是扩展语法的用武之地。

一些个人和组织开始通过添加表,代码块,语法突出显示,URL 自动链接和脚注等其他元素来扩展基本语法。可以通过使用基于基本 Markdown 语法的轻量级标记语言,或者通过向兼容的 Markdown 处理器添加扩展来启用这些元素。

可用性
并非所有 Markdown 应用程序都支持扩展语法元素。您需要检查您的应用程序所使用的轻量级标记语言是否支持您要使用的扩展语法元素。如果没有,仍然可以在 Markdown 处理器中启用扩展。

详细内容可以访问Markdown 中文网 ,如果您希望自己可以帮助我们,您可以在这里找到相当不错的教程,然后开始您的学习之旅(注:Markdown 中文网里 Github 上的一些文档可以不看)。我们推荐您完成基本语法和扩展语法后继续往下。

这是Github调整之后的css,正常情况下所有的扩展都能用,多了一点点东西,很好看哦

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

LaTeX

下列内容部分来自百度百科-LaTeX

LaTeX(LATEX,音译“拉泰赫”)是一种基于 ΤΕΧ 的排版系统,由美国计算机学家 Leslie Lamport 在 20 世纪 80 年代初期开发,利用这种格式,即使使用者没有排版和程序设计的知识也可以充分发挥由 TeX 所提供的强大功能,能在几天、甚至几小时内生成很多具有书籍质量的印刷品。对于生成复杂表格和数学公式,这一点表现得尤为突出。因此它非常适用于生成高印刷质量的科技和数学类文档。这个系统同样适用于生成从简单的信件到完整书籍的所有其他种类的文档。

在我们这个比较学术性的文档中,很多超越纯文本的排版离不开 LaTeX 的帮忙,详情可以访问LaTeX 的官网

LaTeX 的相关学习可以参考LaTeX 语法速查表LaTeX 数学公式大全速查

注意:

有些 LaTeX+Markdown 原生语法没法正常在 Obsidian 中显示,因为 VScode,我们以TyporaMicrosoft Visual Studio Code安装Markdown All in OneLaTeX WorkshopLaTeX Language Support扩展为准。

导出 PDF 以 Typora 和 Marktext 为主

还是整不明白?看看这篇文章吧
LaTeX & Markdown 完全指南 [[mathjax_tutorial_mdeditor_201003]] [[mathjax_tutorial_mdeditor_220713]]

Obsidian

以下内容部分来自少数派

Obsidian is a powerful knowledge base on top of a local folder of plain text Markdown files.

Obsidian是一个强大的知识库,依托 Markdown 和本地文件夹。

很多人都是从卡片笔记知道的 Obsidian,今天我们不谈卡片笔记,只说说 Obsidian 是什么,以及它能做什么。

离开需求和使用场景谈效率工具都是耍流氓,一个工具、一个系统再强大,也要看看是否满足你的使用场景。

Obsidian 是目前看来比较可以满足我们需求的软件。构建知识网络、反向链接,更好地整理与关联…… Obsidian 可以来帮你实现这些目标。

注意:Obsidian 的关联文件写法不是很一样,我们在尝试开发相关扩展来解决这个问题了

具体可以看看这篇少数派文章

我只是来白嫖的

您只需要进行以下步骤:

  1. 把这个仓库克隆到本地

  2. 下载Microsoft Visual Studio Code

  3. 下载您的编辑器

    Typora

    许多人鼎力推荐的 markdown 编辑器,优雅美观,符合使用习惯,不过现在收费

    下载安装后在首选项中选择"使用内建数学公式"

    MarkText

    自从 Typora 收费之后,很多人一直在找免费的 markdown 编辑器,这里个人推荐一下 Marktext,的确相当棒,而且带图形化提示,非常适合新手。

    可惜没有中文

    值得一提的有时候渲染其他软件写的公式会有点问题,推荐自己重写一下大致内容或者用其他编辑器看看

    Microsoft Visual Studio Code

    Microsoft Visual Studio Code 是一款强大的编辑器,和其他几款专门编辑 markdown 的不同,这本来是一款代码编辑器,应该来讲学过写代码的都知道。有些开发者喜欢用这玩意写 markdown(比如我)

    1. 下载安装Microsoft Visual Studio Code(有时候我们喜欢称之为 VScode)

    2. 在扩展商店里安装 Git、Markdown All in OneLaTeX WorkshopLaTeX Language Support四个扩展

  4. 安装Obsidian

  5. 打开 Obsidian,选择库的时候选择克隆下来的文件夹

我希望参与编辑工作

欢迎!我们只是学生,笔记部分一定会有所纰漏,欢迎各位奆佬的鼎力相助!我们也缺很多劳动力,包括优化排版及表述、以及 SVG 图片、有机化学排版的相关帮助!

鉴于本项目所使用的所有软件在 Windows,Linux 和 MacOS 下都可以运行,所以理论上来说你不需要任何对自己系统的进一步配置。

您可以这么做:

  1. 把这个仓库克隆到本地

      git clone https://gitee.com/Situ-Chengxiang/note-sync.git
    
  2. 配置 Git 和 Gitee

    • 会的直接往下跳,不会的参考一下菜鸟教程

      1. 注册 gitee 账户

      2. 生成 ssh 密匙

      3. 下载 git 并配置(Linux 应该大部分自带 git 了,Windows 和 MacOS 用户请自行下载)

  3. 下载您的公式编辑器

    Typora

    许多人鼎力推荐的 markdown 编辑器,优雅美观,符合使用习惯,不过现在收费

    MarkText

    自从 Typora 收费之后,很多人一直在找免费的 markdown 编辑器,这里个人推荐一下 Marktext,的确相当棒,而且带图形化提示,非常适合新手。

    值得一提的有时候渲染其他软件写的可能会加载不出来,稍微调整一下就行。

    Microsoft Visual Studio Code

    Microsoft Visual Studio Code 是一款强大的编辑器,和其他几款专门编辑 markdown 的不同,这本来是一款代码编辑器,

    1. 下载安装Microsoft Visual Studio Code(有时候我们喜欢称之为 VScode)

    2. 在扩展商店里安装GitMarkdown All in OneLaTeX WorkshopLaTeX Language Support四个扩展

  4. 安装Obsidian

  5. 安装 LaTeX 库作为辅助,我们推荐MikLaTeX,相对来讲这玩意体量小不少(完整版会有 2~3GB,MikLaTeX 可以根据需要下载所需要的渲染引擎)

  6. 打开 Obsidian,选择库的时候选择克隆下来的文件夹

  7. 用 Obsidian 开始预览,找到您感兴趣的地方,进入查看,如果渲染异常,将这个文件用其他编辑器打开试试(新手首选 MarkText),如果有所错误或缺漏,您可以帮我们指正补全,修改结束后,保存编辑,然后回到文件夹根目录(带有.gitgnore 文件的文件夹),然后用打开 cmd(或者 Windows Termianl 之类的终端),cd 进文件夹,然后依次输入 git add .

    git push

  8. 您的更改将于审核后合并(不超过 24h)

  9. 每次启动前记得在文件夹内打开终端,然后输入

    git pull

    以查看最新的更改,值得一提的 VSCode 作为代码编辑器这方面做得非常好,我们推荐有能力的各位慢慢从 Marktext 和 Typora 过渡到习惯与 VSCode 和 Git 构建起的开发环境,因为 Marktext 和 Typora 的很多功能可以借助 VSCode 和其强大的扩展以实现。

Tip:

  • 我们其实不推荐一个人同时去负责很多门学科的编辑工作,真的会比较累,每个人只需要注重自己所负责的一块内容就行了,大家合作在后面修修补补,加上我们的审核团队,应该足以满足需求了。

  • 学术性问题的讨论请移步Firprin,记得遵循社区守则

  • 更多编辑须知见下

    编辑工作须知

    1. 学术性交流需要是开放、尊重、理性、和谐

    2. 文件命名原则如下:那门课哪本书-第几章

      如:物理必修第三册-第十三章-电磁波与电磁感应初步

    3. 文件中的排标题方式:

      • 一级标题(H1):本节名称(比如电磁波)

      • 二级标题(H2):本小节名称

      • 三级标题(H3):你觉得需要标题的地方

      • 以此类推可以写到 6 个

    4. 公式拿$\boxed$括起来(去看LaTeX & Markdown 完全指南),数学物理需要长篇大论的记得等号对齐(或者其他好看规范的排法,我觉得教科书是个非常好的例子)

    5. 需要加入视频资源的放个链接摆那就行,你觉得 flame 好使也可以试试

    6. 图片传到图床上,可以不写描述,但是最好吧 link 带上。不推荐直接作为文件塞到附件文件里(CDN 很多,找家靠谱点的!)

    7. 高中阶段的统一去改人教版的,更新的时候如果发现不一样的内容,或需要补充,请在原文下像这样输入

      这是一段和你教材里不一样的文段

      空一行 [你的教材版本-第几本书--第几章-小标题或页码]:

      比如:[浙科版-生物必修第二册-P12]

      下面是你需要修改或者补充的内容


写在最后

我们有计划去开 Github 的坑,以及其实如果您熟悉 Git 的相关操作,熟悉 Markdown,那其实您可以按照自己喜欢的方式进行编辑工作。这里只是提供了 VSCode 一种解决方案。
我们希望您可以参与到编辑工作中来。本仓库知识内容不限于高中部分课程[全版本,有不同的内容编辑时可以考虑补上教材版本],还可以有小学[目前开放浙沪苏版本]、初中[目前开放浙沪苏版本]、竞赛以及大学的内容。感谢您的参与!

开源项目,本项目有多个 contributor(贡献者),大家的写作风格各有特色,希望各位都能愉快的学习。

生为学,源于学,富于学

我需要 PDF 稿件

  • 您可以用 Typora 进行转换;

  • Obsidian 对于大部分文档应该也没问题,但是化学学科需要特别注意;

  • MarkText 也可以,只要预览正常一定可以给你染出来;

  • Pandoc 也可以成为很棒的选择,不过需要一定的学习成本;

我需要自己的版本

Fork it! 然后自己编辑吧!

关于国际化

We welcome you greatly as if you could help us to do so.

目标

咱们的目标绝对不是建立一个独立于教材的培训体系,也不是培养一个独立的教辅,我们来源于教材,服务于教材。您可以 fork 整个仓库然后用自己的笔记修改。GPL3 协议允许您自由复制传播,但是,请将获利的不少于千分之一给予公益事业。
语文和英语作为语言类学科,考试内容相当宽泛笔记内容就不按照教材编排了,可以自行发挥肆意写作
.obsidian文件夹内是Obsidian读取笔记时的配置文件夹,如果涉及到侵权的问题,请立即联系我,一定第一时间删除! 拆分的更细的版本在做了!!!!