Skip to content

Commit 083b0ea

Browse files
robhrt7robhrt7
committed
add version number to doc template
1 parent 598be8f commit 083b0ea

File tree

24 files changed

+33
-35
lines changed

24 files changed

+33
-35
lines changed

‎assets/css/project/layout.less

+7
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,13 @@
6969
color: @black;
7070
}
7171

72+
.source_header-meta {
73+
font-size: @fz-size-xs !important;
74+
line-height: 1.2 !important;
75+
color: @color-aux;
76+
margin-bottom: 20px;
77+
}
78+
7279
.source-main-only(h1,{
7380
.source_main_h1;
7481
});

‎core/views/doc.ejs

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<%- header %>
2727
<div class="source_main source_col-main" role="main">
2828
<h1><%= info.title %></h1>
29+
<div class="source_header-meta">v.<%- engineVersion %></div>
2930
<%- content %>
3031
</div>
3132
<%- footer %>

‎docs/api/load-events/info.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
22
"keywords": "events, spec loaded",
3-
"title": "Spec Load Event"
3+
"title": "Spec Load Event",
4+
"template": "doc"
45
}

‎docs/api/load-events/readme.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# Spec Load Event
2-
3-
Spec load event API helps to organize Spec loading flow, and define the final load event of all content, modules and plugins.
1+
Spec load event API helps to organize Spec loading flow, and define the final load event of all content, modules and plugins.
42

53
## The Problem
64

‎docs/api/plugins/info.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
22
"keywords": "plugins, middlewares",
3-
"title": "Writing SourceJS Plugins and Middlewares"
3+
"title": "Writing SourceJS Plugins and Middlewares",
4+
"template": "doc"
45
}

‎docs/api/plugins/readme.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Writing SourceJS Plugins and Middlewares
2-
31
SourceJS core contains only default APIs for most common use cases, all specific features we move to plugins, that could contain back-end and client-side improvements.
42

53
## Starting Templates

‎docs/api/rest-api/info.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
22
"keywords": "api, rest",
3-
"title": "REST API"
3+
"title": "REST API",
4+
"template": "doc"
45
}

‎docs/api/rest-api/readme.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# SourceJS REST API
2-
3-
From 0.4.0 version, SourceJS started to grow own REST API for flexible plugins development and easy side services integration. API provides full access to Spec contents, navigation tree and other useful features.
1+
From 0.4.0 version, SourceJS started to grow own REST API for flexible plugins development and easy side services integration. API provides full access to Spec contents, navigation tree and other useful features.
42

53
## GET Specs
64

‎docs/auth/info.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
22
"keywords": "auth, github",
3-
"title": "Github Auth"
3+
"title": "Using Github Auth",
4+
"template": "doc"
45
}

‎docs/auth/readme.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Using GitHub Auth
2-
31
## Quick Start
42

53
Before you start, please make sure that you have referenced GitHub App registered. Please visit [this link](https://developer.github.com/guides/basics-of-authentication/#registering-your-app) to get more information.

‎docs/base/info.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2-
"title": "* Main Engine Documentation"
2+
"title": "Main Engine Documentation",
3+
"template": "doc"
34
}

‎docs/base/readme.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Main Engine Documentation
2-
31
This page contains main information about SourceJS engine and it's set-up.
42

53
SourceJS documentation is rendered by the engine itself and is shipped together with each instance.
@@ -171,6 +169,7 @@ Plugins are working in the same way as core modules, but are kept outside the ma
171169

172170
Here is a list of official plugins:
173171

172+
* [sourcejs-md-react](https://www.npmjs.com/package/sourcejs-md-react) (new)
174173
* [sourcejs-contrib-browser-sync](https://github.com/sourcejs/sourcejs-contrib-browser-sync) (new)
175174
* [sourcejs-react](https://www.npmjs.com/package/sourcejs-react) (new)
176175
* [sourcejs-contrib-dss](http://github.com/sourcejs/sourcejs-contrib-dss) (new)

‎docs/clarify/info.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2-
"title": "Clarify - Spec Section Testing Environment"
2+
"title": "Clarify - Spec Section Testing Environment",
3+
"template": "doc"
34
}

‎docs/clarify/readme.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Clarify - Spec Section Testing Environment
2-
31
SourceJS middleware, that allows to open separate documentation examples in custom or clean environment for component testing and development.
42

53
## General information

‎docs/configuration/info.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
22
"title": "Engine Configuration",
3-
"keywords": "options, options.js, sourcejs-options, context"
3+
"keywords": "options, options.js, sourcejs-options, context",
4+
"template": "doc"
45
}

‎docs/configuration/readme.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Engine Configuration
2-
31
SourceJS engine is highly configurable and allows to override almost any options for your special needs.
42

53
## Configuration Hierarchy

‎docs/data-nav/info.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2-
"title": "Autogenerated Navigation"
2+
"title": "Auto-generated Navigation",
3+
"template": "doc"
34
}

‎docs/data-nav/readme.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Auto-generated Navigation
2-
31
Navigation blocks in SourceJS are automatically generated on client-side, replacing a defined HTML hook with hand-crafted configuration.
42

53
## Embedding

‎docs/grunt/info.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2-
"title": "Build Tasks With Grunt"
2+
"title": "Build Tasks With Grunt",
3+
"template": "doc"
34
}

‎docs/grunt/readme.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Build Tasks With Grunt
2-
31
## Intro
42

53
[Grunt](http://gruntjs.com/) tasks are used to build dev and production assets for Source.

‎docs/info-json/info.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
22
"title": "Info.json - Spec Description",
3-
"keywords": "spec meta, template, specFile"
3+
"keywords": "spec meta, template, specFile",
4+
"template": "doc"
45
}

‎docs/info-json/readme.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Info.json - Spec Description
2-
31
`info.json` file in spec folder is used for defining page meta information and local options set-up. Use it for customizing global navigation or with your custom fields.
42

53
## Used options

‎docs/migration/info.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2-
"title": "Migration notes"
2+
"title": "Migration Notes",
3+
"template": "doc"
34
}

‎docs/migration/readme.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Migration instructions
2-
31
Here you will find migration instructions from different Source versions
42

53
## From 0.4.0-beta to 0.4.0-rc

0 commit comments

Comments
 (0)