Git Product home page Git Product logo

intro's Introduction

intro

upclinux.github.io/intro

网站上总结了一些新手常见的问题。

注意本项目的名字是入门指“引”,不是指“导”。为了使 Linux 新手不会太受折磨,又不会打消折腾电脑的乐趣,我们只列一些有关“思路”、“注意事项”的东西。具体操作仍需自己探索或找搜索引擎。

本网站不打算成为百科全书。可以访问 Deepin Wiki,这是一个很好的手册。

如何编辑本网站

这里,进去之后往下看。

需要注意的是,本 Repo 的分支不是 master,而是 gh-pages,说明这是个子页面。在本地调试的时候,网址应该是 http://127.0.0.1:4000/intro/ 并且尾部的斜线不能丢。

本网站的黑科技

本网站仍然采用 Jekyll 博客系统。但这次毕竟不是博客,因此还要重新设计主题,使其看起来更像个帮助系统。

如何保证顺序

我们仍然使用博客的“分类”来组织文章,不过这次分类和文章都是有顺序的,所以文章的“发布时间”是有要求的。按照“规定的时间”来发布文章,产生的结果才是按照顺序的。

  1. 目前有 11 个分类,具体名字和对应目录可以看 _config.yml。顺序是确定的,但是为了路径整齐,第一个分类的“发布时间”应该是 2001 年,第二个分类的“发布时间”应该是 2002 年……以此类推。

  2. 在每个分类下面有若干文章。文章的排列顺序是从最新到最旧,所以把第一篇文章的发布日期设定成了 12 月 31 日,第二篇是 12 月 30 日……

    除了改文件名,还需要修改文件头部的日期,因为 Jekyll 看的是文件内容而不是文件名。

如何才能被 FAQ “收录”

首页有个 FAQ,收录了一些常见问题,点击之后会跳到对应页面。这是自动生成的。

博客正文头部会有一段信息,写着标题、日期什么的。这个是可以定制的,所以加了一个 faq 属性。faq 是个数组,数组内容就是 FAQ 中应该收录的问题。

下面是一个会被 FAQ 收录的例子:

---
layout: post
title:  "从何开始"
date:   2001-12-31 00:00:00
faq: ["第一个问题?", "第二个问题?"]
---

编辑注意事项

(不完全参考维基百科)

原则

注意版权:不要抄袭、复制他人的劳动果实。如果确实需要复制,请标明来源。公有领域和确实属于自己的作品除外。

内容

  1. 启发思路:作为“入门指引”,我们更多的是让读者意识到“是什么”、“有什么”和“能够做什么”。一般不用写特别详细的操作步骤。
  2. 说明书:对于一些特殊的问题,例如“如何安装QQ”是一个不需要点拨的问题,直接告诉读者详细操作即可。
  3. 原创研究:维基百科反对原创研究,但是我们不反对,只要你的研究成果确实有利于读者的学习。
  4. 内容清晰:要让文字内容条理清晰。没有人喜欢杂乱无章的内容,而且,在手机时代没有人喜欢看一个又长又枯燥的段落。
  5. 适度幽默(恶搞):适度幽默,或者采用一些打比方的形式有助于读者理解一些复杂概念。为什么不用呢?

观点

  1. 由于读者一般是经验比较少的新手,因此给出合理的观点可能更有利于学习。
  2. 避免谈政治问题。

论述

  1. 请尽量以中立的第三人称视角来书写文章。这意味着,使用“我”、“你”、“我们协会”都是不恰当的。
    • 文字当然可以使用“我”。在这种情况下,请标清作者是谁(ID 也可)。
  2. 在论述过程中,应该认为自己不属于任何一个团体,也就是说——
    • 你没有身份。虽然读者可能基本上都是大学生,但是不要认为你自己也是大学生。
    • 没有 “Linux 协会” 这个组织。所以提及 Linux 协会,提及协会人员及事务都是不恰当的。
    • 不要提及“石油大学”的事物,因为读者不一定是石油大学的。

intro's People

Contributors

vjudge0 avatar deemoding avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.