Repository files navigation

Online Demo
A resume/CV generator, parsing information from YAML file to generate a static website which you can deploy on theGithub Pages. Exactly like resume-versionHexo.

[sudo] npm install -g barn-cli or[sudo] yarn global add barn-cli
(Of course, you should installNode.js with npm before that)

0. barn -h: check the manual
1. barn init: init a barn folder usinggit clone, so make sure you are connecting to thewww
2. cd barn-starter
3. fillconfig.yml with your own customized configs
4. fill YAML files in folderthemes/${your theme}/content/ with your own information
5. make use ofbarn server to debug your pages and repeat step 3-5 until it satisfies you
6. barn deploy: deploy to your own github resume repository
7. trun on Github Pages, seehttps://pages.github.com/ for more instruction

• barn -h
  Checking the manual of this tool is the very first thing you should do.

• barn init / i
  Initiate a barn project usinggit clone withMaples7/barn-starter.

• barn genrate / g
  Generate ultimate static website to folderdist.

• barn server / s
  Watch any changes of any files and apply them to folderdist immediately, so you can open*.html in folderdist with your browser to debug your pages locally.

• barn deploy / d
  Deploy to a git-based server such asGithub Pages andCoding Pages.

• barn -v
  Check the version.

• default: the default theme of barn

You can download any themes above and put them in folderthemes and apply any one of them by changing the config insideTheme block inconfig.yml.

(Thers is only a theme calleddefault in folderthemes for now, you are welcomed to customize your own and make it open source. If you'd like to, catch the key points of instruction below.)

Steps:

1. On Github, create a barn theme project whose name is supposed to follow patternbarn-theme-XXXX
2. Put all html templates in the root directory./, all css files in./css/ and all images in./image/
3. Make starter YAML files for information needed to render pages in./content/ to tell users what they should provide
4. Full tests and detail document are required in your own theme project
5. Post a PR to this project to list your own theme insideThemes block above, please note whether any other template engines are needed besidespug and I'll give some support in my code

You are welcomed to review this project for more information you need.

DEBUG=barn-cli barn [command]: addDEBUG=barn-cli at the beginning of any command to get more information about the running status of program.

• barn-starter
• barn-cli

• Maples7: Creator and maintainner of this project
• ShadowWood: Maker of thedefault theme

MIT