"
77 | ]
78 | }
79 |
--------------------------------------------------------------------------------
/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dignifiedquire/clean-documentation-theme/2a01efb8dcdc3176805f74790f25213d3e3a062c/screenshot.png
--------------------------------------------------------------------------------
/src/components/app.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const React = require('react')
4 | const PropTypes = require('prop-types')
5 | const Radium = require('radium')
6 | const {StyleRoot} = Radium
7 | const {Container, Column, Row} = require('radium-bootstrap-grid')
8 |
9 | const Header = require('./header')
10 | const Nav = require('./navigation')
11 | const Content = require('./content')
12 | const {lineHeight} = require('./styles')
13 | const Utils = require('../utils')
14 |
15 | const hasMembers = (doc) => {
16 | const m = doc.members
17 | return m.static.length > 0 ||
18 | m.instance.length > 0 ||
19 | (m.events && m.events.length > 0)
20 | }
21 |
22 | const App = ({options, docs}) => {
23 | const containerStyle = {
24 | paddingTop: lineHeight(4)
25 | }
26 |
27 | const navItems = docs.map((doc) => {
28 | return {
29 | name: doc.name,
30 | members: hasMembers(doc) ? doc.members : null
31 | }
32 | })
33 |
34 | const navStyle = {
35 | position: 'fixed',
36 | height: '80%',
37 | maxWidth: '300px'
38 | }
39 |
40 | const utils = new Utils(options, docs)
41 | const radiumConfig = {
42 | userAgent: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
43 | }
44 | return (
45 |
46 |
50 |
51 |
52 |
53 |
57 |
60 |
61 |
67 |
70 |
71 |
72 |
73 |
74 | )
75 | }
76 |
77 | App.propTypes = {
78 | options: PropTypes.object.isRequired,
79 | docs: PropTypes.array.isRequired
80 | }
81 |
82 | module.exports = Radium(App)
83 |
--------------------------------------------------------------------------------
/src/components/content/description.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const React = require('react')
4 | const Radium = require('radium')
5 | const PropTypes = require('prop-types')
6 |
7 | const {lineHeight} = require('../styles')
8 | const Utils = require('../../utils')
9 |
10 | const Description = ({content, utils}) => {
11 | const rendered = {
12 | __html: utils.md(content)
13 | }
14 |
15 | const style = {
16 | marginTop: lineHeight(0.5),
17 | marginBottom: lineHeight(0.5)
18 | }
19 |
20 | return (
21 |
24 | )
25 | }
26 |
27 | Description.propTypes = {
28 | content: PropTypes.oneOfType([
29 | PropTypes.string,
30 | PropTypes.object
31 | ]).isRequired,
32 | utils: PropTypes.instanceOf(Utils).isRequired
33 | }
34 |
35 | module.exports = Radium(Description)
36 |
--------------------------------------------------------------------------------
/src/components/content/example.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const React = require('react')
4 | const Radium = require('radium')
5 | const PropTypes = require('prop-types')
6 |
7 | const Utils = require('../../utils')
8 |
9 | const Example = ({caption, content, utils}) => {
10 | let renderedCaption
11 |
12 | if (caption) {
13 | renderedCaption = (
14 |
15 | )
16 | }
17 |
18 | const rendered = {
19 | __html: utils.highlight(content)
20 | }
21 |
22 | return (
23 |
24 |
Example
25 | {renderedCaption}
26 |
27 |
30 |
17 | {list.map((example, i) => (
18 |
23 | ))}
24 |
25 | )
26 | }
27 |
28 | Examples.propTypes = {
29 | list: PropTypes.array,
30 | utils: PropTypes.instanceOf(Utils).isRequired
31 | }
32 |
33 | module.exports = Radium(Examples)
34 |
--------------------------------------------------------------------------------
/src/components/content/extends.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const React = require('react')
4 | const Radium = require('radium')
5 | const PropTypes = require('prop-types')
6 |
7 | const Utils = require('../../utils')
8 |
9 | const Extends = ({list, utils}) => {
10 | if (!list || !list.length) {
11 | return null
12 | }
13 |
14 | const wrapperStyle = {
15 | display: 'inline'
16 | }
17 |
18 | const supers = {
19 | __html: list.map((sup) => {
20 | return utils.autolink(sup.name)
21 | }).join(', ') + '.'
22 | }
23 |
24 | return (
25 |
26 | Extends
27 |
28 |
29 | )
30 | }
31 |
32 | Extends.propTypes = {
33 | list: PropTypes.array,
34 | utils: PropTypes.instanceOf(Utils).isRequired
35 | }
36 |
37 | module.exports = Radium(Extends)
38 |
--------------------------------------------------------------------------------
/src/components/content/index.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const React = require('react')
4 | const Radium = require('radium')
5 | const {Style} = Radium
6 | const PropTypes = require('prop-types')
7 |
8 | const Utils = require('../../utils')
9 | const {contentStyles} = require('../styles')
10 |
11 | const Section = require('./section')
12 |
13 | const Content = ({utils, docs}) => {
14 | return (
15 |
16 |
17 | {docs.map((section, i) => (
18 |
25 | ))}
26 |
27 | )
28 | }
29 |
30 | Content.propTypes = {
31 | utils: PropTypes.instanceOf(Utils).isRequired,
32 | docs: PropTypes.array.isRequired
33 | }
34 |
35 | module.exports = Radium(Content)
36 |
--------------------------------------------------------------------------------
/src/components/content/param.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const React = require('react')
4 | const Radium = require('radium')
5 | const PropTypes = require('prop-types')
6 |
7 | const Utils = require('../../utils')
8 | const Type = require('./type')
9 | const {lineHeight} = require('../styles')
10 |
11 | const ListItem = Radium(({
12 | name,
13 | val,
14 | defaultVal,
15 | description,
16 | utils
17 | }) => {
18 | const descriptionStyle = {
19 | display: 'inline-block'
20 | }
21 | const liStyle = {
22 | paddingBottom: lineHeight(0.5)
23 | }
24 |
25 | return (
26 |
27 |
32 | :
33 |
36 |
37 | )
38 | })
39 |
40 | const Param = ({
41 | name,
42 | typeVal,
43 | defaultVal,
44 | description,
45 | properties,
46 | utils
47 | }) => {
48 | let propertyList
49 |
50 | if (properties && properties.length > 0) {
51 | propertyList = properties.map((p) => (
52 |
59 | ))
60 | }
61 |
62 | return (
63 |
64 |
71 | {propertyList}
72 |
73 | )
74 | }
75 |
76 | Param.propTypes = {
77 | name: PropTypes.string.isRequired,
78 | typeVal: PropTypes.any,
79 | defaultVal: PropTypes.string,
80 | description: PropTypes.object,
81 | properties: PropTypes.array,
82 | utils: PropTypes.instanceOf(Utils).isRequired
83 | }
84 |
85 | module.exports = Radium(Param)
86 |
--------------------------------------------------------------------------------
/src/components/content/params.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const React = require('react')
4 | const Radium = require('radium')
5 | const PropTypes = require('prop-types')
6 |
7 | const Utils = require('../../utils')
8 | const Param = require('./param')
9 |
10 | const Params = ({params, utils}) => {
11 | if (!params || !params.length) {
12 | return null
13 | }
14 |
15 | const listStyle = {
16 | listStyle: 'none',
17 | marginLeft: 0,
18 | paddingLeft: 0
19 | }
20 |
21 | return (
22 |
23 |
Parameters
24 |
25 | {params.map((param) => (
26 |
34 | ))}
35 |
36 |
16 |
Returns
17 | {list.map((ret, i) => (
18 |
19 |
26 | ))}
27 |
24 |
{name}
25 | {members.map((m, i) => (
26 |
34 | ))}
35 |
36 | )
37 | }
38 |
39 | SectionGroup.propTypes = {
40 | name: PropTypes.string.isRequired,
41 | members: PropTypes.array.isRequired,
42 | parent: PropTypes.string.isRequired,
43 | utils: PropTypes.instanceOf(Utils).isRequired
44 | }
45 |
46 | module.exports = Radium(SectionGroup)
47 |
--------------------------------------------------------------------------------
/src/components/content/section-member.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const React = require('react')
4 | const Radium = require('radium')
5 | const PropTypes = require('prop-types')
6 |
7 | const Utils = require('../../utils')
8 | const Signature = require('./signature')
9 | const Description = require('./description')
10 | const Examples = require('./examples')
11 | const Params = require('./params')
12 | const SourceLink = require('./source-link')
13 | const Returns = require('./returns')
14 | const Throws = require('./throws')
15 | const Extends = require('./extends')
16 | const See = require('./see')
17 |
18 | const {lineHeight} = require('../styles')
19 |
20 | const SectionMember = ({
21 | namespace,
22 | name,
23 | description,
24 | member,
25 | parent,
26 | utils
27 | }) => {
28 | let displayParent
29 |
30 | if (parent) {
31 | displayParent = parent + '.'
32 | }
33 |
34 | let displayName = displayParent + name
35 | if (name === 'constructor') {
36 | displayName = name
37 | }
38 |
39 | const style = {
40 | marginBottom: lineHeight(2)
41 | }
42 |
43 | return (
44 |
45 |
46 |
47 | {displayName}
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
40 |
41 |
42 | {name}
43 |
44 |
45 |
49 |
50 |
51 |
52 |
53 |
54 |
55 | {memberTypes.map((type, i) => (
56 |
62 | ))}
63 |
27 |
See
28 |
29 | {list.map((link, i) => (
30 | -
31 |
35 |
36 | ))}
37 |
38 |
16 |
19 | )
20 | }
21 |
22 | Signature.propTypes = {
23 | member: PropTypes.object,
24 | utils: PropTypes.instanceOf(Utils).isRequired
25 | }
26 |
27 | module.exports = Radium(Signature)
28 |
--------------------------------------------------------------------------------
/src/components/content/source-link.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const React = require('react')
4 | const Radium = require('radium')
5 | const PropTypes = require('prop-types')
6 |
7 | const GoCode = require('react-icons/lib/go/code')
8 |
9 | const SourceLink = ({context}) => {
10 | if (!context || !context.github) {
11 | return null
12 | }
13 |
14 | const style = {
15 | float: 'right'
16 | }
17 |
18 | return (
19 |
23 |
24 |
25 | )
26 | }
27 |
28 | SourceLink.propTypes = {
29 | context: PropTypes.object
30 | }
31 |
32 | module.exports = Radium(SourceLink)
33 |
--------------------------------------------------------------------------------
/src/components/content/throws.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const React = require('react')
4 | const Radium = require('radium')
5 | const PropTypes = require('prop-types')
6 |
7 | const Utils = require('../../utils')
8 |
9 | const Throws = ({list, utils}) => {
10 | if (!list || !list.length) {
11 | return null
12 | }
13 |
14 | return (
15 |
16 |
Throws
17 | {list.map((ret, i) => (
18 |
19 |
27 | ))}
28 |
19 | {value}
20 |
21 | )
22 | })
23 |
24 | const Version = Radium(({value}) => {
25 | const style = {
26 | fontFamily: monoFont,
27 | fontWeight: 300
28 | }
29 |
30 | return (
31 |
32 | {value}
33 |
34 | )
35 | })
36 |
37 | const Header = ({name, version, project}) => {
38 | const style = {
39 | boxShadow: '0px 2px 3px 0px rgba(0, 0, 0, 0.25)',
40 | height: lineHeight(2.5),
41 | width: '100%',
42 | minWidth: '100%',
43 | marginLeft: '0',
44 | marginRight: '0',
45 | position: 'fixed',
46 | zIndex: 99,
47 | background: '#FFFFFF',
48 | paddingTop: '10px',
49 | paddingBottom: '10px',
50 | paddingLeft: '20px',
51 | paddingRight: '20px'
52 | }
53 |
54 | let projectLink = null
55 |
56 | const projectLinkStyle = {
57 | textAlign: 'right',
58 | float: 'right !important',
59 | fontSize: '36px'
60 | }
61 |
62 | if (project) {
63 | projectLink = (
64 |
65 |
66 |
67 |
68 |
69 | )
70 | }
71 | const logoStyle = {
72 | fontSize: '36px',
73 | verticalAlign: 'inherit',
74 | marginRight: '20px'
75 | }
76 |
77 | const titleStyle = {
78 | display: 'inline-block'
79 | }
80 |
81 | return (
82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
91 |
92 | {projectLink}
93 |
94 |
95 |
60 |
{name}
61 |
62 | {items.map((member, i) => (
63 |
68 | ))}
69 |
70 |
139 |
140 |
141 | {name}
142 |
143 |
144 | {members ? (
145 |
146 | {membersElements}
147 |
148 | ) : null}
149 |
185 |
186 | {items.map((doc, i) => (
187 |
196 |
Converts from Result to ?Error
\n'
23 | )
24 | })
25 | })
26 |
27 | it('.formatType', () => {
28 | const formatType = u.formatType
29 |
30 | expect(formatType(undefined)).to.be.eql('any')
31 |
32 | expect(formatType({
33 | type: 'NameExpression',
34 | name: 'Foo'
35 | })).to.be.eql('Foo')
36 |
37 | expect(formatType({
38 | type: 'NameExpression',
39 | name: 'Buffer'
40 | })).to.be.eql('Buffer')
41 | })
42 |
43 | it('.highlight', () => {
44 | expect(
45 | u.highlight('var text = "hello"')
46 | ).to.be.eql(
47 | 'var text = "hello"'
48 | )
49 | })
50 |
51 | it('signature', () => {
52 | expect(
53 | u.signature({
54 | kind: 'class',
55 | name: 'Test',
56 | params: [{
57 | name: 'a',
58 | type: {type: Syntax.NumericLiteralType, value: 'number'}
59 | }]
60 | })
61 | ).to.be.eql(
62 | 'new Test(a: number)'
63 | )
64 |
65 | expect(
66 | u.signature({
67 | kind: 'function',
68 | name: 'test',
69 | params: [{
70 | name: 'a',
71 | type: {type: Syntax.NumericLiteralType, value: 'number'}
72 | }],
73 | returns: [{
74 | type: {type: Syntax.NumericLiteralType, value: 'number'}
75 | }]
76 | })
77 | ).to.be.eql(
78 | 'test(a: number): number'
79 | )
80 |
81 | expect(
82 | u.signature({
83 | kind: 'property',
84 | name: 'test',
85 | tags: [{
86 | title: 'type',
87 | type: {type: Syntax.NumericLiteralType, value: 'number'}
88 | }]
89 | })
90 | ).to.be.eql(
91 | 'test: number'
92 | )
93 | })
94 | })
95 |
--------------------------------------------------------------------------------