Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  1. Create a source code URL for hosting
    I create the URL as https://github.com/pnpdjie/includeMD
  2. Create and develop md files for the project on local
    As we need to divide the Release note into multiple files for multiple projects, We need to use Jekyll to create an project. ( to install Jekyll, you can refer to the link)
    1. new a project

    2. add an include folder( you see there are more files because I run Jekyll's compile)
    3. add the independent markdown files, these files contributed by different projects.

    4.  edit the index file to add the markdown files, we can use *content{:toc} and {%include name.md%}



  3. commit the markdown files as source code to the  repository https://github.com/pnpdjie/includeMD
    ps:
    1. Suggest to run Jekyll's compile before committing.
      Image Added
    2. After  committing, we can edit/review/modify the markdown files as other source code on github (same way to gerrit)
      Image Added
  4. Config the repository to generate a webpage:
    1. go to settings and find the github pages
    2. choose the master branch to publish website and name it


  5. Go the the site to see what we have done (smile)
    https://pnpdjie.github.io/includeMD/

...