如何使用Overleaf在Medium上创建学术博客

在其中,我描述了一个过程,在这个过程中,我们从 Overleaf 开始, 并在 Medium 上建立了一个学术博客, 其中包含参考文献和所有内容; 您无法格式化Medium中的参考文献来撰写学术论文。 这是一种方法。

这是论文的背面版本,您可以和我一起撰写/编辑

介绍

亨利·马蒂斯(Henri Matisse)谈创意

网络和在线协作写作与版本控制系统正在影响学术交流的过程。 Jaret Byrnes(Byrnes等人,2013年)在2013年写道,学术出版物的未来将取决于四个支柱:学术产品生态系统,立即开放的访问,开放的同行评审以及对参与该过程的充分认可。 关于版本控制及其对学术写作的影响,Karthik Ram(Ram 2013)撰写了有关Git和版本控制的教程,该教程是可重现学术和维护知识代码和人工制品不可或缺的一部分。 在世界各地组织越来越多的Resbaz活动,这使新兴的和成熟的研究人员能够使用数字工具。 Cornelius Puschmann(2013)在《开放科学》一书中写道

公民社会期望与科学进行对话,而不是接受演讲。 因此,应将社交媒体(博客,Wiki,社交网站)的收费视为支持专家和非专业人士之间建立更加平等的普遍的长期转变,而不是推动这种转变。”(Puschmann 2014)

普斯曼的论点表明,有必要将学术写作的更正式形式与社交媒体中不那么正式的参与相结合。 这种“杂交”并不容易,但是在社交媒体影响力日益增强的时代,这是必需的。 近来,以多种形式呈现的观点的媒介的长阅读格式变得流行。 然而,Medium缺乏一个正式的结构,可以允许在这里提出更多的学术或学术论据。 例如,使用参考和基于引用的归因,数据表; 另一方面,它提供了一个绝佳的环境,可以全盘阅读和“散布”想法,并吸引了广泛的读者群来共享和传播想法。 当时的挑战是,要连接更正式的学术交流所提供的真实和经过审核的信息的世界,以及能够吸收该信息并传播媒介所能传播的庞大而动态的读者群。

在这里,我想编写一个工作流,我们可以将这两个过程结合在一起。 我将写一些在线工具,这些工具可以一起满足Byrnes所写的四个支柱的需求:创建学术产品生态系统,即时开放的访问权限,允许开放的同行评审以及完全认可参与处理。 这套工具中的第一个是用于学术写作的可公开访问的协作在线Latex或Markdown工具。 Latex是用于学术写作的行之有效的工具,并且借助在线“ Web皮肤”,可以基于富文本界面进行写作,它变得易于编写和协作。 我每天都使用Overleaf,它可以满足我的所有写作需求。 还有其他工具,例如ShareLatex和Authorea。 所有这些功能都提供了易于编写的界面,用户可以在这些服务上获得免费帐户,并且可以以私人文档和公共文档的形式编写文档,并且可以在线共享文档,以便他或她的合作者可以使用Web界面进行编写。 除了LateX用于编写也可以在网络上阅读的学术文档之外,Markdown是另一种广泛用于网络创作的格式。 约翰·格鲁伯(John Gruber)撰写Markdown。 Markdown不仅使编写基于Web的文档变得容易,而且与LaTeX相比,还有其他优点,即易于阅读以及使用更简单的标记代码集。 但是,本机Markdown例如不支持插入引文和表格,因此,一些作者将Markdown扩展为创作更复杂的文档。 这是markdown,latex和html之间的并排比较。

标记语言的比较:markdown,latex和html

正如您在markdown中所看到的,与原始html文件或原始乳胶文件相比,文本中的代码更具可读性。 因此,乳胶和html文件都需要先渲染,然后才能被称为“人类可读”,而通过markdown,即使它们以原始文本文件格式显示,它们也可以被读取。 此外,在降价促销中,允许使用html代码。 最初的markdown格式进行了扩展:Fletcher Penney编写了Multimarkdown包,该包扩展了Markdown的功能以允许使用表格和引用。 Markdown的另一个变体包括Github风格的Markdown,用于在github中编写文本。

Markdown语法提供了一套优秀的易于应用的规则,您可以使用这些规则以纯文本编写器(例如记事本(Windows)或Textedit(Mac)或任何纯文本编辑器)编写纯文本。 您也可以使用文字处理程序来编写Markdown文档,但是最好避免这样做。 Markdown同时独立于平台,无处不在且有用。 但是,对于许多作者来说,将文档从一种格式转换为另一种格式很重要。 这可以通过约翰·麦克法兰(John Macfarlane)的Pandoc(通常称为文档转换的瑞士军刀)轻松实现。 最近,Karthik Ram等人(2012年)的学术降价项目扩大了降价的范围,可以撰写学术论文。 这项工作是不完整的,但是为该领域的发展提供了绝佳的机会。

Pandoc和scholdoc是将以纯文本形式编写的文档转换为可读单元的方式,这些可读单元还与其他软件程序(例如Web浏览器或文字处理软件)兼容。 但是,对于协作写作和透明的研究,还需要一个严格的版本控制系统,以便可以查看文档的多个版本以进行更改并进行还原或处理。 Git提供了此功能。 网上git书很好地概述了git版本控制的工作原理。 本质上,将git下载到文件夹中的计算机,然后与作为远程计算机的联机存储库连接并交换文件。 在进行更改以及从远程存储库推送和拉出更改时,将暂存或添加文件,然后提交文件。 github是一个在线git存储库,任何人都可以使用它来维护版本控制,并免费获得最大存储和使用文件大小不超过1 GB的文件。 这是一个可免费下载的git备忘单。

现在,我们有了一种写纯文本文档的方式,有些是直观的(降价标记),并且可以立即用机器和人类阅读,而有些则主要是机器可读的(HTML和乳胶),这是我们将文档发布到网上的时候。 Hugo是一种基于Go编程语言的网站生成器。 它快速且易于学习。 您可以从以下站点下载Hugo程序https://github.com/spf13/hugo/releases

下载源代码并安装Hugo之后,您将为您的网站创建一个新文件夹,并在该文件夹中使用以下代码设置一个Hugo网站:

hugo new site sitename

Hugo将使用以下文件和文件夹创建一个新站点:

  • 原型
  • 内容
  • 版面
  • 主题
  • config.toml
  • 数据
  • 静态的

对于此工作流程,我们将处理文件夹的内容,主题,静态内容,并将编辑config.toml。 内容将包含您的文件(帖子,文章等),静态将包含图像,我通常还会保留书目文件(Pandoc将使用的书目文件)。 在父目录的静态文件夹中创建一个img文件夹:

mkdir static/img

主题最初将为空,您将需要使用特定主题填充主题。 您可以在Hugo主题网站上找到主题,在这里,我们将从以下网站安装极简主义的Hugo主题:https://github.com/digitalcraftsman/hugo-minimalist-theme

使用终端,并在父目录中编写以下代码以安装hugo-minimalist-theme:

cd themes git clone https://github.com/digitalcraftsman/hugo-minimalist-theme.git

安装hugo-minimalist-theme后,如果您浏览到themes文件夹中hugo-minimalist-theme文件夹的exampleSite站点,则会看到config.toml文件。 将该文件复制到您的父目录。 还将将在主题文件夹中的static / img文件夹中看到的两个图像复制到父目录的static / img文件夹中。

因此,这是代码(来自父目录):

cd themes/hugo-minimalist-theme/exampleSite (导航至示例站点)

cp config.toml /Documents/demo/ (将config.toml复制到父文件夹)

cp static/img/*png static/img/*jpg /Documents/demo/static/ (这会将img文件夹中的图像复制到父站点的static / img文件夹中

最后,在文本编辑器中打开config.toml站点并配置:

必须填写基本网址,在我的情况下,我将其称为arins-papers.surge.sh(您可以给它起另一个名字); 请注意xy.surge.sh格式,即使我们尚未配置喘振,我们也将尽快完成。

下一步,使用以下代码在Hugo上创建帖子(我将称呼文件hello-world.md):

hugo new post/hello-world.md

请注意,这是一篇新文章,将在Hugo网站的内容文件夹中创建,并且是markdown文件。 markdown文件的优点在于,您可以在其中编织html和markdown代码,因此请确保它是markdown。 另外,请确保您在父目录中,并且该目录是post / filename。 斜线很重要。 这将在文件夹content / post中创建一个名为hello-world.md的新文件(还将创建一个名为post btw的新文件夹)。

如果然后编辑hello-world.md,您将看到类似以下内容:

但是您会发现这是极简主义,因此我们将在三个加号之间更改文档的上半部分(这被称为TOML样式元数据)。 因此,我们将标题更改为“ Hello World”,并添加了一些标签,例如“ tutorial”等。我们仍然将hello-world.md的正文保留为空。 现在,我们可以填充一些简单的信息,例如markdown中的第二级标题和一些伪文本。 稍后我们将使用Overleaf的信息填充此页面。

输入浪涌!

目前,我们有一个非常简单的极简网站,我们将在线发布该网站并进行审查。 我们将通过Surge做到这一点。 Surge是一个Web应用程序,您可以在其中使用html,css和javascript,并使用它们的服务器免费部署网站。 您不必担心服务器配置等。您将需要从Surge网站获得一个免费帐户(您可以免费注册一个个人帐户,并确保获得令牌)。 设置好Surge帐户并获得令牌后,即可开始通过Surge部署网站。

因此,这是您的工作:

  1. 首先使用hugo建立网站,然后在命令提示符下建立hugo 。 您可以选择指示主题。 您必须在父文件夹中才能执行此操作,否则它将不起作用。
  2. 这将创建一个名为“ public”的文件夹,该文件夹将使您的网站扁平化
  3. 现在通过surge public/ your-site.surge.sh推动它激增

在我们的例子中,假设我们使用以下内容创建了一个演示站点:

hugo ; surge public/ arins-papers.surge.sh

这些步骤结束时,是该网站的屏幕截图:

没有什么花哨。 在这个阶段非常准。 这将改变。

如果是第一次,Surge会要求您提供令牌和电子邮件地址,并且在第一次之后,您只需发出以下代码即可进行部署:

rm -rf public/ ; hugo ; surge public/ your-site.surge.sh

请记住,每次在站点上更改文件并需要构建Hugo网站时,请删除或删除public /文件夹,然后让hugo从头开始重建它。

将您的Hugo网站与Overleaf连接

现在我们处于家中。 首先,获得一个免费的Overleaf帐户。 然后,当您登录Overleaf时,您会看到可以开始一个新项目。 启动一个空白的Overleaf文档。 然后,访问Overleaf编辑器顶部的“ SHARE”按钮,并注意带有git url的克隆(见图):

我假设您的计算机中已经安装了pandoc和git。 您可以通过以下方式测试它们:

git –version (将返回有效值) pandoc –version (将返回一些信息)

逐步设置您的雨果博客和Overleaf之间的连接

  1. 从父目录创建一个git仓库
  2. git init
  3. 连接到Overleaf git remote add overleaf URL (URL是您唯一的Overleaf URL)
  4. 添加内容/和静态/文件夹
  5. git add content/ static/
  6. 提交添加并推送
  7. git commit -m some message
  8. git push overleaf master

您将看到Overleaf将在文件夹空间中填充content /和static /文件夹。 添加一个新文件,并在post文件夹中将其命名为“ article.tex”。 写在背面。 添加书目文件并将其称为“ refs.bib”。 用书目信息填充refs.bib文件。

在“背面”一侧工作时,请记住以下几点:

  • 将所有围兜文件放入静态文件夹
  • 将所有图像文件放入静态文件夹中的img文件夹
  • 在Overleaf中添加图像时,请使用static / img / filename.extension
  • 将PDF生成和乳胶代码生成过程分开

将Overleaf文章拉到git repo并Pandoc

现在,从父文件夹中,拉出Overleaf存储库中的文件和文件夹。 为此,请在父目录中执行以下操作:

git pull overleaf master

这将拉出下页的文件夹和文件。

然后使用pandoc将乳胶文件转换为html并将内容连接到hello-world.md文件:

  pandoc -f latex -t html content / post / article.tex –过滤器pandoc-citeproc –bibliography static / refs.bib | 猫>> content / post / hello-world.md 

现在,在文本编辑器中修改hello-world.md并进行编辑。 实质上,

  • 从Overleaf文档中的图片标签中,删除“ static /”
  • 在文档末尾的参考信息之前添加“ ## References”

在父文件夹中,使用hugo构建网站:

rm -rf public/; hugo; surge public/ arins-papers.surge.sh

现在,在不是移动浏览器的兼容Web浏览器中打开“中”。 单击“故事”,然后单击“导入故事”,然后填写高峰网站URL。 按照说明进行操作,您的页面将被导入中。

参考文献

伯恩斯,贾勒特·埃克,爱德华·巴斯克维尔,布鲁斯·卡隆,卡梅隆·尼隆,卡罗尔·特诺皮尔,马克·希尔德·豪厄尔,琥珀色巴登,朗尼·奥尔森和克里斯托弗·洛蒂。 2013。“学术出版的四大支柱:未来与基金会。” PeerJ PrePrints。

Cornelius的Puschmann。 2014年。“(微)博客科学? 关于新型学术交流形式的潜力和制约因素的说明。”《 开放科学》 ,第89-106页。 施普林格。

Ram,Karthik。 2013年。“ Git可以促进更高的可重复性和科学的透明度。” 生物医学的源代码 8(1)。 BioMed Central:7。