| commit | 63c65e0016586c030e9fa6734668fb8ccee9a795 | [log] [tgz] |
|---|---|---|
| author | yumengwang03 <yumeng.wang@merico.dev> | Tue May 03 18:13:55 2022 +0800 |
| committer | Louis.z <louis.s4372121@gmail.com> | Thu May 05 12:53:59 2022 +0800 |
| tree | c7bb675edecf1e61566896ac8aca28d4eba6b740 | |
| parent | 07b097ee5e218f3b56d5f13c8eecdc4d680431b4 [diff] |
added blog instruction to readme
In your command line tool, go to this directory and run yarn. Then run yarn start and your browser will open at http://localhost:3000. To run on a different port, run yarn start -- -- port xxxx.
Thank you for contributing to DevLake blog! We can't wait to hear your voice!
Because DevLake only accepts blog posts submitted through PRs, we want to make this process as painless as poissble by putting together this instruction.
The DevLake website maintains blog posts in two languages, English and Chinese(simplified), so we prefer that you submit your blog posts in both languages. However, if you are only familiar with one language, you can submit your blog posts in one language--either English or Chinese--but please put the same files in both directories of the two languages. We will help you with the translation based on our current work capacity.
English blog directory: blog/your-blog-post
Chinnese blog directory: i18n/zh/docusaurus-plugin-content-blog/your-blog-post
Notice: No matter if you are submitting blog posts in one or two languages, please follow both the English and Chinese instructions as follows:
blog directory, find the file named authors.yml and add your author info in the format of:warren: name: Warren Chen (陈映初) title: DevLake Contributor url: https://github.com/warren830 image_url: https://github.com/warren830.png
If you are not submitting for the first time, please skip this step and go to Step No.2.
In the blog directory, create a folder for a single blog post and name it in the format of yyyy-mm-dd-your-blog-post-title, so that all blog posts will be arranged in the order of time automatically.
Inside this folder, create a markdownfile and name it index.md. All of your blog post content goes into this file. If you use any images in your blog post, please also place the image files in the same folder.
In the beginning of index.md, please add the following information to help with the SEO:
--- slug: your-blog-post-title title: Your Blog Post Title authors: warren tags: [DevLake, ants, deadlock] ---
Please make sure that the value for authors match the author info you entered in authors.yml.
<!--truncate--> at an appropriate place in your index.md. (We recommend putting it after approximately 300 words, but it is flexible as long as you think it make sense.) For example:--- slug: truncation-example title: Truncation Example authors: yumeng tags: [DevLake, blog] --- All these will be part of the blog post summary. Even this. <!--truncate--> But anything from here on down will not be. Not this. Or this.
The steps for submitting the Chinese version of your blog post are very similar to that of English, but in a different directory with a few tweaks.
i18n/zh/docusaurus-plugin-content-blog directory, find the file named authors.yml and add your author info in the format of:warren: name: 陈映初 title: DevLake贡献者 url: https://github.com/warren830 image_url: https://github.com/warren830.png
If you are not submitting for the first time, please skip this step and go to Step No.2.
In the i18n/zh/docusaurus-plugin-content-blog directory, create a folder for a single blog post and name it with the exact the name of the blog post folder that you have used for the English submission, so that the two files for two languages can match automatically.
Inside this folder, create a markdownfile and name it index.md. All of your blog post content goes into this file. If you use any images in your blog post, please also place the image files in the same folder.
In the beginning of index.md, please add the following information to help with the SEO:
--- slug: your-blog-post-title title: 你的文章题目 authors: warren tags: [DevLake, ants, deadlock] ---
Please make sure that the value for authors match the author info you entered in authors.yml.
<!--truncate--> at an appropriate place in your index.md. (We recommend putting it after approximately 200 Chinese characters, but it is flexible as long as you think it make sense.) For example:--- slug: truncation-example title: Truncation Example authors: yumeng tags: [DevLake, blog] --- All these will be part of the blog post summary. Even this. <!--truncate--> But anything from here on down will not be. Not this. Or this.
After completing the above steps, please submit a PR to merico-dev/lake-website for review. Happy blogging!