Skip to content

docs: update README#184

Draft
Ir1d wants to merge 2 commits intomasterfrom
readme
Draft

docs: update README#184
Ir1d wants to merge 2 commits intomasterfrom
readme

Conversation

@Ir1d
Copy link
Member

@Ir1d Ir1d commented May 9, 2020

  • add en version (brief)
  • add screenshot to README
  • update list of features (如下)
  • package.json (见下方链接)

参考:

待填写:

- url: https://ng.oi-wiki.org/
  repo: https://github.com/OI-wiki/gatsby-oi-wiki
  description: Generate material style modern docs/tutorial/wiki websites using Gatsby + MDX
  tags:
  - Documentation
  - Markdown
  - Official
  - MDX
  - Search
  - SEO
  - PWA
  - Language:TypeScript
  - Linting
  - Netlify
  - Styling:CSS-in-JS
  features:
    - Write using Markdown / MDX
	- Material style theme
	- Syntax Highlighting using VS Code's engine
	- Search Integration with Elasticsearch
	- Progressive Web App, Works Offline
	- [ ] Google Analytics Integration
	- Automatically generated sidebar navigation, table of contents, previous/next
	- Dark Mode toggle
	- Edit on Github
	- Fully customisable
	- [ ] Rich embeds and live code editor using MDX
	- [ ] Easy deployment: Deploy on Netlify / Now.sh / Docker

@render

This comment has been minimized.

@render

This comment has been minimized.

@cbw2007
Copy link
Collaborator

cbw2007 commented May 24, 2020

package.json也需要改(

@cbw2007
Copy link
Collaborator

cbw2007 commented May 24, 2020

"private": true,
"name": "demo",
"version": "0.0.0",
"license": "MIT",

@cbw2007
Copy link
Collaborator

cbw2007 commented May 24, 2020

package.json也需要改(

https://docs.npmjs.com/creating-a-package-json-file 补充

@render

This comment has been minimized.

"name": "gatsby-oi-wiki",
"version": "0.0.1",
"license": "Apache-2.0",
"description": "A template for wiki.Powered by Gatsby.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

有待商榷

"gatsby",
"wiki"
],
"author": "",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

待填写:

  • author - 包的作者姓名。
  • contributors - 包的其他贡献者姓名。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants