Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renew of the documentation Pt.2 #25

Merged
merged 4 commits into from
Nov 18, 2016
Merged

Renew of the documentation Pt.2 #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
63b2d60
Replaces Prettify with highlight.js and makes jQuery, require.js comp…
Kovah Nov 17, 2016
c3f0a6d
Moves all asset into a separate folder for a cleaner folder structure
Kovah Nov 17, 2016
728d28b
Replaces the CSS files with Bootstrap 4-based Sass, compiled by Grunt
Kovah Nov 17, 2016
6c35f3c
Update for the docs itself, adds completely restructured "making games"
Kovah Nov 17, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ public/games
public/examples
docs/hft
docs/relayserver
docs/**/*.html
!docs/**/toc.html
!docs/unity/install.html
!docs/unity/samples.html
images/src
.DS_Store
*~
Expand Down
73 changes: 72 additions & 1 deletion Gruntfile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,45 @@ module.exports = function(grunt) {
'docs/dotnet',
],
},
sass: {
docs: {
options: {
sourceMap: true,
outputStyle: 'compressed',
},
files: [{
expand: true,
cwd: 'docs/assets/scss',
dest: 'docs/assets/css',
src: ['**/*.scss'],
ext: '.css',
}]
},
},
uglify: {
docs_js: {
files: {
'docs/assets/3rdparty/jquery.js': ['node_modules/jquery/dist/jquery.min.js'],
'docs/assets/3rdparty/require.js': ['node_modules/requirejs/require.js'],
},
},
},
watch: {
docs_sass: {
files: ['docs/assets/scss/**/*.scss'],
tasks: ['sass:docs'],
options: {
spawn: false,
},
},
docs_md: {
files: ['docs/**/*.md', 'docs/**/toc.html'],
tasks: ['builddocs'],
options: {
spawn: false,
},
},
},
eslint: {
target: [
'cli',
Expand All @@ -51,10 +90,14 @@ module.exports = function(grunt) {
});

grunt.loadNpmTasks('grunt-contrib-clean');
grunt.loadNpmTasks('grunt-contrib-concat');
grunt.loadNpmTasks('grunt-contrib-uglify');
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-jsdoc');
grunt.loadNpmTasks('grunt-eslint');
grunt.loadNpmTasks('grunt-sass');

// WIP!!!
// Docs
grunt.registerTask('unitydocsgen', function() {
var done = this.async();
var foo = require('./dev/js/dotnetdocs');
Expand All @@ -71,6 +114,16 @@ module.exports = function(grunt) {
{
filespec: "docs/*.md",
},
{
filespec: "docs/making-games/*.md",
mainURL: "/docs/making-games",
toc: "docs/making-games/toc.html",
},
{
filespec: "docs/setup/*.md",
mainURL: "/docs/setup",
toc: "docs/setup/toc.html",
},
{
filespec: "docs/unity/*.md",
mainURL: "/docs/unity",
Expand All @@ -92,6 +145,24 @@ module.exports = function(grunt) {
});
});

grunt.registerTask('docsassets', [
'sass:docs',
'uglify:docs_js',
]);

grunt.registerTask('docsdev', [
'clean:docs',
'builddocs',
'docsassets',
'watch',
]);

grunt.registerTask('docsbuild', [
'clean:docs',
'builddocs',
'docsassets',
]);

grunt.registerTask('default', ['eslint', 'clean:docs', 'jsdoc']);
};

4 changes: 1 addition & 3 deletions dev/templates/index.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<title>{{title}}</title>

<link href="/public/hft-icon.png" rel="shortcut icon" type="image/png">
<link rel="stylesheet" href="/docs/css/base.css" type="text/css" />
<link rel="stylesheet" href="/docs/css/lesson.css" type="text/css" />
<link rel="stylesheet" href="/docs/css/index.css" type="text/css" />
<link rel="stylesheet" href="/docs/assets/css/styles.css" type="text/css" />
</head>
<body>
{{{include "dev/templates/header.template"}}}
Expand Down
44 changes: 22 additions & 22 deletions dev/templates/lesson.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,53 +51,53 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

<title>{{title}}</title>
<link href="/public/hft-icon.png" rel="shortcut icon" type="image/png">
<link rel="stylesheet" href="/docs/css/base.css" type="text/css" />
<link rel="stylesheet" href="/docs/css/lesson.css" type="text/css" />
<link rel="stylesheet" href="/docs/assets/css/styles.css" type="text/css" />
</head>
<body>
{{{include "dev/templates/header.template"}}}
<div class="container">
<div class="lesson-title">
<div class="docs-title">
<h1>{{title}}</h1>
</div>
<div class="row">
<div class="col-sm-8 lesson-main">
<div class="col-sm-8 docs-content">
{{{content}}}
<hr/>
<div>
<div class="docs-footer">
<div>Questions? <a href="http://stackoverflow.com/questions/tagged/{{bs.stackoverflowTag}}">Ask on stackoverflow</a>.</div>
<div>Issue/Bug? <a href="{{bs.bugIssueURL}}">Create an issue on github</a>.</div>

<div id="disqus_thread"></div>
<script type="text/javascript">
<div class="docs-comments">
<div id="disqus_thread"></div>
<script type="text/javascript">
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
var disqus_shortname = '{{bs.disqusShortName}}'; // required: replace example with your forum shortname
var disqus_identifier = '{{title}}';
var disqus_title = '{{title}}';

/* * * DON'T EDIT BELOW THIS LINE * * */
(function() {
if (window.location.hostname.indexOf("{{bs.disqusCheckStr}}") < 0) {
return;
}
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
if (window.location.hostname.indexOf("{{bs.disqusCheckStr}}") < 0) {
return;
}
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
</script>
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
</div>
</div>
</div>
<div class="col-sm-3 col-sm-offset-1 lesson-sidebar">
<div class="col-sm-3 col-sm-offset-1 docs-sidebar">
{{{include bs.toc}}}
</div>
</div>
</div>
</body>
<script src="/docs/3rdparty/jquery-1.11.2.min.js"></script>
<script src="/docs/3rdparty/prettify.js"></script>
<script src="/docs/js/lesson.js"></script>
<script src="/docs/assets/3rdparty/jquery.js"></script>
<script src="/docs/assets/js/lesson.js"></script>
<script src="/docs/assets/3rdparty/highlight.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
{{{include "dev/templates/analytics.template" }}}
</html>

Expand Down
4 changes: 0 additions & 4 deletions docs/3rdparty/jquery-1.11.2.min.js
View file
Open in desktop

This file was deleted.

Loading