challions/hexo.github.io

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 28 Commits
api		api
css		css
docs		docs
js		js
news		news
CNAME		CNAME
apple-touch-icon-114x114.png		apple-touch-icon-114x114.png
apple-touch-icon-120x120.png		apple-touch-icon-120x120.png
apple-touch-icon-144x144.png		apple-touch-icon-144x144.png
apple-touch-icon-152x152.png		apple-touch-icon-152x152.png
apple-touch-icon-57x57.png		apple-touch-icon-57x57.png
apple-touch-icon-60x60.png		apple-touch-icon-60x60.png
apple-touch-icon-72x72.png		apple-touch-icon-72x72.png
apple-touch-icon-76x76.png		apple-touch-icon-76x76.png
apple-touch-icon-precomposed.png		apple-touch-icon-precomposed.png
apple-touch-icon.png		apple-touch-icon.png
atom.xml		atom.xml
browserconfig.xml		browserconfig.xml
favicon-160x160.png		favicon-160x160.png
favicon-16x16.png		favicon-16x16.png
favicon-196x196.png		favicon-196x196.png
favicon-32x32.png		favicon-32x32.png
favicon-96x96.png		favicon-96x96.png
favicon.ico		favicon.ico
index.html		index.html
logo.png		logo.png
mstile-144x144.png		mstile-144x144.png
mstile-150x150.png		mstile-150x150.png
mstile-310x150.png		mstile-310x150.png
mstile-310x310.png		mstile-310x310.png
mstile-70x70.png		mstile-70x70.png
robots.txt		robots.txt
sitemap.xml		sitemap.xml

Repository files navigation

<!DOCTYPE html>
<html>
<head prefix="og: http://ogp.me/ns#">
 <meta charset="utf-8">
 <title>Contributing | Hexo</title>
 <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
 <link rel="canonical" href="http://hexo.io/docs/contributing.html">
 <link rel="apple-touch-icon" sizes="57x57" href="/apple-touch-icon-57x57.png">
 <link rel="apple-touch-icon" sizes="114x114" href="/apple-touch-icon-114x114.png">
 <link rel="apple-touch-icon" sizes="72x72" href="/apple-touch-icon-72x72.png">
 <link rel="apple-touch-icon" sizes="144x144" href="/apple-touch-icon-144x144.png">
 <link rel="apple-touch-icon" sizes="60x60" href="/apple-touch-icon-60x60.png">
 <link rel="apple-touch-icon" sizes="120x120" href="/apple-touch-icon-120x120.png">
 <link rel="apple-touch-icon" sizes="76x76" href="/apple-touch-icon-76x76.png">
 <link rel="apple-touch-icon" sizes="152x152" href="/apple-touch-icon-152x152.png">
 <link rel="icon" type="image/png" href="/favicon-196x196.png" sizes="196x196">
 <link rel="icon" type="image/png" href="/favicon-160x160.png" sizes="160x160">
 <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
 <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
 <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
 <meta name="msapplication-TileColor" content="#2f83cd">
 <meta name="msapplication-TileImage" content="/mstile-144x144.png">
 <link rel="stylesheet" href="/css/style.css" type="text/css">
 <link href="//fonts.googleapis.com/css?family=Lato:300,700" rel="stylesheet" type="text/css">
 <link href="//fonts.googleapis.com/css?family=Source+Code+Pro:400,700" rel="stylesheet" type="text/css">
 <link rel="alternative" href="/atom.xml" title="Hexo" type="application/atom+xml">
 <meta name="description" content="Development
Hexo welcomes you to join the development of Hexo. This document will help you through the process.
Before You Start
Please follow the coding style:
Follow Google JavaScript Style Guide.">
<meta property="og:type" content="website">
<meta property="og:title" content="Contributing">
<meta property="og:url" content="http://hexo.io/docs/contributing.html">
<meta property="og:site_name" content="Hexo">
<meta property="og:description" content="Development
Hexo welcomes you to join the development of Hexo. This document will help you through the process.
Before You Start
Please follow the coding style:
Follow Google JavaScript Style Guide.">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Contributing">
<meta name="twitter:description" content="Development
Hexo welcomes you to join the development of Hexo. This document will help you through the process.
Before You Start
Please follow the coding style:
Follow Google JavaScript Style Guide.">
<meta name="twitter:site" content="@hexojs">
<meta property="fb:admins" content="100000247608790">
 
<script>
 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
 })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 ga('create', 'UA-4910098-10', 'hexo.io');
 ga('send', 'pageview');
</script>
</head>
<body>
 <header id="header">
 <div class="outer">
 <div class="inner">
 <h1 id="logo-wrap">
 <a href="/" id="logo">Hexo</a>
 <a id="main-nav-toggle"></a>
 </h1>
 <nav id="main-nav">
 <ul id="main-nav-list">
 
 <li class="main-nav-item">
 <a href="/docs/" class="main-nav-link">Docs</a>
 </li>
 
 <li class="main-nav-item">
 <a href="/api/classes/Hexo.html" class="main-nav-link">API</a>
 </li>
 
 <li class="main-nav-item">
 <a href="/news/" class="main-nav-link">News</a>
 </li>
 
 <li class="main-nav-item">
 <a href="https://github.com/tommy351/hexo/wiki/Plugins" class="main-nav-link">Plugins</a>
 </li>
 
 <li class="main-nav-item">
 <a href="https://github.com/tommy351/hexo/wiki/Themes" class="main-nav-link">Themes</a>
 </li>
 
 </ul>
 <a href="https://github.com/hexojs/hexo" id="github-btn" title="GitHub" target="_blank"></a>
 <a id="search-btn" class="st-search-launcher" title="Search"></a>
 </nav>
 </div>
 </div>
</header>
 <article class="page" itemscope itemtype="http://schema.org/Article">
 <header id="page-banner">
 <div class="outer">
 <div id="page-banner-inner" class="inner">
 <h1 id="page-title" itemprop="name">Contributing</h1>
 <a href="https://github.com/hexojs/site/blob/master/source/docs/contributing.md" title="Improve this doc" id="page-edit-link"></a>
 </div>
 </div>
 </header>
 <div class="outer">
 <div id="mobile-menu-wrap"></div>
 <div class="page-content">
 <div class="toc-wrap">
 <strong class="toc-title">Contents</strong>
 <ol class="toc"><li class="toc-item toc-level-2"><a class="toc-link" href="#Development"><span class="toc-number">1.</span> <span class="toc-text">Development</span></a><ol class="toc-child"><li class="toc-item toc-level-3"><a class="toc-link" href="#Before_You_Start"><span class="toc-number">1.1.</span> <span class="toc-text">Before You Start</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Workflow"><span class="toc-number">1.2.</span> <span class="toc-text">Workflow</span></a></li></ol></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Updating_Documentation"><span class="toc-number">2.</span> <span class="toc-text">Updating Documentation</span></a></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Reporting_Issues"><span class="toc-number">3.</span> <span class="toc-text">Reporting Issues</span></a></li></ol>
 </div>
 <div class="page-entry" itemprop="articleBody">
 <h2 id="Development">Development</h2>
<p>Hexo welcomes you to join the development of Hexo. This document will help you through the process.</p>
<h3 id="Before_You_Start">Before You Start</h3>
<p>Please follow the coding style:</p>
<ul>
<li>Follow <a href="http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml" target="_blank" rel="external">Google JavaScript Style Guide</a>.</li>
<li>Use soft-tabs with a two space indent.</li>
<li>Don’t put commas first.</li>
</ul>
<h3 id="Workflow">Workflow</h3>
<ol>
<li>Fork the project.</li>
<li>Clone the repository to your computer and install dependencies.</li>
</ol>
<figure class="highlight bash"><pre><div class="line">$ git clone https://github.com/&lt;username&gt;/hexo.git</div><div class="line">$ <span class="built_in">cd</span> hexo</div><div class="line">$ npm install</div><div class="line">$ git submodule update --init</div></pre></figure>
<ol>
<li>Create a feature branch for your change.</li>
</ol>
<figure class="highlight bash"><pre><div class="line">$ git checkout -b new_feature</div></pre></figure>
<ol>
<li>Start hacking. Don’t forget to run tests.</li>
<li>Push the branch:</li>
</ol>
<figure class="highlight bash"><pre><div class="line">$ git push origin new_feature</div></pre></figure>
<ol>
<li>Create a pull request against the <code>master</code> branch and describe the change.</li>
</ol>
<blockquote class="note warn"><strong class="note-title">Don't change version in package.json</strong>
<p>When making changes on Hexo, don’t change version number in <code>package.json</code>.</p>
</blockquote>
<h2 id="Updating_Documentation">Updating Documentation</h2>
<p>The Hexo documentation is open source and you can find the source code on <a href="https://github.com/hexojs/site" target="_blank" rel="external">hexojs/site</a>. To update the documentation:</p>
<ol>
<li>Fork the project</li>
<li>Clone the repository to your computer and install dependencies.</li>
</ol>
<figure class="highlight bash"><pre><div class="line">$ git clone https://github.com/&lt;username&gt;/site.git</div><div class="line">$ <span class="built_in">cd</span> site</div><div class="line">$ npm install</div></pre></figure>
<ol>
<li>Start editing the documentation. You can start the server for live previewing.</li>
</ol>
<figure class="highlight bash"><pre><div class="line">$ hexo server</div></pre></figure>
<ol>
<li>Push the branch:</li>
<li>Create a pull request against the <code>master</code> branch and describe the change.</li>
</ol>
<h2 id="Reporting_Issues">Reporting Issues</h2>
<p>When you encounter some problems when using Hexo, you can find the solutions in [Troubleshooting] or ask me on <a href="https://github.com/hexojs/hexo/issues" target="_blank" rel="external">GitHub</a> or <a href="https://groups.google.com/group/hexo" target="_blank" rel="external">Google Group</a>. If you can’t find the answer, please report it on GitHub.</p>
<ol>
<li>Represent the problem in debug mode.</li>
</ol>
<figure class="highlight bash"><pre><div class="line">$ hexo --debug</div></pre></figure>
<ol>
<li>Check the version info.</li>
</ol>
<figure class="highlight bash"><pre><div class="line">$ hexo version</div></pre></figure>
<ol>
<li>Post both debug message and version info on GitHub.</li>
</ol>
 </div>
 <footer id="page-footer">
 <time id="page-footer-updated" datetime="2014-07-06T09:41:20.000Z" itemprop="dateModified">Last updated: Jul 6 2014</time>
 <a href="troubleshooting.html" id="page-footer-prev" title="Troubleshooting">Prev</a>
 </footer>
 
<section id="comments">
 <div id="disqus_thread">
 <noscript>Please enable JavaScript to view the <a href="//disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
 </div>
</section>
 </div>
 <aside id="sidebar">
 
 <strong class="sidebar-title">Getting Started</strong>
 
 <a href="/docs/index.html" class="sidebar-link">Overview</a>
 
 <a href="/docs/setup.html" class="sidebar-link">Setup</a>
 
 <a href="/docs/configuration.html" class="sidebar-link">Configuration</a>
 
 <a href="/docs/commands.html" class="sidebar-link">Commands</a>
 
 <a href="/docs/migration.html" class="sidebar-link">Migration</a>
 
 
 <strong class="sidebar-title">Basic Usage</strong>
 
 <a href="/docs/writing.html" class="sidebar-link">Writing</a>
 
 <a href="/docs/drafts.html" class="sidebar-link">Drafts</a>
 
 <a href="/docs/generating.html" class="sidebar-link">Generating</a>
 
 <a href="/docs/tag-plugins.html" class="sidebar-link">Tag Plugins</a>
 
 <a href="/docs/server.html" class="sidebar-link">Server</a>
 
 <a href="/docs/deployment.html" class="sidebar-link">Deployment</a>
 
 
 <strong class="sidebar-title">Customization</strong>
 
 <a href="/docs/permalinks.html" class="sidebar-link">Permalinks</a>
 
 <a href="/docs/themes.html" class="sidebar-link">Themes</a>
 
 <a href="/docs/variables.html" class="sidebar-link">Variables</a>
 
 <a href="/docs/pagination.html" class="sidebar-link">Pagination</a>
 
 <a href="/docs/helpers.html" class="sidebar-link">Helpers</a>
 
 <a href="/docs/plugins.html" class="sidebar-link">Plugins</a>
 
 
 <strong class="sidebar-title">Advanced</strong>
 
 <a href="/docs/models.html" class="sidebar-link">Models</a>
 
 <a href="/docs/events.html" class="sidebar-link">Events</a>
 
 
 <strong class="sidebar-title">Miscellaneous</strong>
 
 <a href="/docs/troubleshooting.html" class="sidebar-link">Troubleshooting</a>
 
 <a href="/docs/contributing.html" class="sidebar-link current">Contributing</a>
 
 
</aside>
 </div>
</article>
 <footer id="footer">
 <div class="outer">
 <div class="inner">
 <div id="footer-copyright">
 &copy; 2014 <a href="http://zespia.tw/">SkyArrow</a><br>
 Background: <a href="http://subtlepatterns.com/shattered/" target="_blank">Shattered</a> by <a href="http://luukvanbaars.com/" target="_blank">Luuk van Baars</a>
 </div>
 <div id="footer-links">
 <a href="https://twitter.com/hexojs" id="footer-link-twitter" class="footer-link" target="_blank"><span>Twitter</span></a>
 <a href="https://github.com/hexojs/hexo" id="footer-link-github" class="footer-link" target="_blank"><span>GitHub</span></a>
 </div>
 </div>
 </div>
</footer>
 
<!-- Disqus -->
<script>
 var disqus_shortname = 'hexojs';
 
 var disqus_url = 'http://hexo.io/docs/contributing.html';
 
 (function(){
 var dsq = document.createElement('script');
 dsq.type = 'text/javascript';
 dsq.async = true;
 dsq.src = '//go.disqus.com/embed.js';
 (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
 })();
</script>
<!-- Swiftype -->
<script>
var Swiftype = window.Swiftype || {};
(function() {
 Swiftype.key = 'DDvzs7LQ9kdKssQNQLcv';
 /** DO NOT EDIT BELOW THIS LINE **/
 var script = document.createElement('script'); script.type = 'text/javascript'; script.async = true;
 script.src = "//s.swiftypecdn.com/embed.js";
 var entry = document.getElementsByTagName('script')[0];
 document.getElementsByTagName('script')[0].parentNode.insertBefore(script, entry);
}());
</script>
<script src="//ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="/js/retina.min.js" type="text/javascript"></script>
<script src="/js/script.js" type="text/javascript"></script>
<!-- Google+ -->
<script type="text/javascript" src="//apis.google.com/js/plusone.js"></script>
<!-- Twitter -->
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
</body>
</html>

About

hexo.io

Releases

No releases published

Packages

Contributors

Languages

CSS 93.9%
JavaScript 6.1%

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

challions/hexo.github.io

Folders and files

Latest commit

History

Repository files navigation

About

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages

Uh oh!

Contributors

Uh oh!

Languages

Folders and files

Latest commit

History

Repository files navigation

About

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages