3 | Docxy
4 |Docxy is a React based open-source documentation site generator. Build beautiful, blazing fast documentation sites for your projects with just markdown.
5 |
3 | Docxy is a React based open-source documentation site generator. Build beautiful, blazing fast documentation sites for your projects with just markdown.
5 | tags containing syntax highlighting;
24 | // defaults to 'language-' (eg ).
25 | classPrefix: "language-",
26 | // This is used to allow setting a language for inline code
27 | // (i.e. single backticks) by creating a separator.
28 | // This separator is a string and will do no white-space
29 | // stripping.
30 | // A suggested value for English speakers is the non-ascii
31 | // character '›'.
32 | inlineCodeMarker: null,
33 | // This lets you set up language aliases. For example,
34 | // setting this to '{ sh: "bash" }' will let you use
35 | // the language "sh" which will highlight using the
36 | // bash highlighter.
37 | aliases: {},
38 | // This toggles the display of line numbers globally alongside the code.
39 | // Defaults to false.
40 | // If you wish to only show line numbers on certain code blocks,
41 | // leave false and use the {numberLines: true} syntax below
42 | showLineNumbers: true,
43 | // If setting this to true, the parser won't handle and highlight inline
44 | // code used in markdown i.e. single backtick code like `this`.
45 | noInlineHighlight: true,
46 | },
47 | },
48 | ],
49 | },
50 | },
51 | {
52 | resolve: "gatsby-plugin-local-search",
53 | options: {
54 | // A unique name for the search index. This should be descriptive of
55 | // what the index contains. This is required.
56 | name: "pages",
57 | // Set the search engine to create the index. This is required.
58 | // The following engines are supported: flexsearch, lunr
59 | engine: "flexsearch",
60 | // Provide options to the engine.
61 | // Note: Only the flexsearch engine supports options.
62 | engineOptions: "speed",
63 | // GraphQL query used to fetch all data for the search index. This is
64 | // required.
65 | query: `{
66 | allMarkdownRemark {
67 | nodes {
68 | id
69 | fields{
70 | slug
71 | }
72 | frontmatter {
73 | title
74 | description
75 | }
76 | rawMarkdownBody
77 | }
78 | }
79 | }`,
80 | // Field used as the reference value for each document.
81 | // Default: "id".
82 | ref: "id",
83 | // List of keys to index. The values of the keys are taken from the
84 | // normalizer function below.
85 | // Default: all fields
86 | index: [ "title", "body", "description" ],
87 | // List of keys to store and make available in the UI. The values of
88 | // the keys are taken from the normalizer function below.
89 | // Default: all fields
90 | store: [ "id", "slug", "title", "description" ],
91 | // Function used to map the result from the GraphQL query. This should
92 | // return an array of items to index in the form of flat objects
93 | // containing properties to index. The objects must contain the `ref`
94 | // field above (default: 'id'). This is required.
95 | normalizer: ({ data }) => data.allMarkdownRemark.nodes.filter(node => node.fields.slug !== "/404/").map(node => ({
96 | id: node.id,
97 | slug: node.fields.slug,
98 | title: node.frontmatter.title,
99 | description: node.frontmatter.description,
100 | body: node.rawMarkdownBody,
101 | })),
102 | },
103 | },
104 | "gatsby-transformer-yaml",
105 | "gatsby-plugin-typescript",
106 | ],
107 | };
108 |
--------------------------------------------------------------------------------
/gatsby-node.js:
--------------------------------------------------------------------------------
1 | "use strict";
2 |
3 | const path = require("path");
4 | const { createFilePath } = require("gatsby-source-filesystem");
5 |
6 | exports.onCreateNode = ({ node, getNode, actions }) => {
7 | const { createNodeField } = actions;
8 | if (node.internal.type === "MarkdownRemark") {
9 | const slug = createFilePath({ node, getNode, basePath: "pages" });
10 | createNodeField({
11 | node,
12 | name: "slug",
13 | value: slug,
14 | });
15 | }
16 | };
17 |
18 | exports.createPages = ({ graphql, actions }) => {
19 | const { createPage } = actions;
20 |
21 | return new Promise(resolve => {
22 | graphql(`
23 | {
24 | allMarkdownRemark {
25 | edges {
26 | node {
27 | fields {
28 | slug
29 | }
30 | }
31 | }
32 | }
33 | }
34 | `).then(result => {
35 | result.data.allMarkdownRemark.edges.forEach(({ node }) => {
36 | createPage({
37 | path: node.fields.slug,
38 | component: path.resolve("./src/templates/page.tsx"),
39 | context: {
40 | slug: node.fields.slug,
41 | },
42 | });
43 | });
44 | resolve();
45 | });
46 | });
47 | };
48 |
49 | exports.createSchemaCustomization = ({ actions }) => {
50 | const typeDefs = `
51 | type ContentYaml implements Node {
52 | title: String!
53 | description: String!
54 | copyright: String
55 | logo: String
56 | website: String
57 | repository: String
58 | twitter: String
59 | navigation: [ContentNavigation!]
60 | links: [ContentNavigationLink!]
61 | }
62 | type ContentNavigation {
63 | section: String!
64 | links: [ContentNavigationLink!]!
65 | }
66 | type ContentNavigationLink {
67 | name: String!
68 | link: String!
69 | }
70 | `;
71 |
72 | actions.createTypes(typeDefs);
73 | };
74 |
--------------------------------------------------------------------------------
/global.d.ts:
--------------------------------------------------------------------------------
1 | declare module "gatsby-plugin-dark-mode";
2 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "docxy",
3 | "description": "Docxy is a React based open-source documentation site generator. Build beautiful, blazing fast documentation sites for your projects with just markdown.",
4 | "version": "2.0.0",
5 | "private": true,
6 | "author": "Sankarsan Kampa",
7 | "license": "MPL-2.0",
8 | "repository": "https://github.com/docxy/docgen",
9 | "scripts": {
10 | "build": "./node_modules/.bin/gatsby build",
11 | "clean": "./node_modules/.bin/gatsby clean",
12 | "start": "./node_modules/.bin/gatsby develop",
13 | "lint": "./node_modules/.bin/eslint . --ext .js,.jsx,.ts,.tsx"
14 | },
15 | "dependencies": {
16 | "gatsby": "^2.24.74",
17 | "gatsby-plugin-dark-mode": "^1.1.2",
18 | "gatsby-plugin-glamor": "^2.3.13",
19 | "gatsby-plugin-local-search": "^2.0.0",
20 | "gatsby-plugin-react-helmet": "^3.3.14",
21 | "gatsby-plugin-typescript": "^2.4.21",
22 | "gatsby-remark-prismjs": "^3.5.16",
23 | "gatsby-source-filesystem": "^2.3.34",
24 | "gatsby-transformer-remark": "^2.8.38",
25 | "gatsby-transformer-yaml": "^2.4.14",
26 | "glamor": "^2.20.40",
27 | "prismjs": "^1.22.0",
28 | "react": "^16.13.1",
29 | "react-dom": "^16.13.1",
30 | "react-helmet": "^6.1.0",
31 | "react-icons": "^3.11.0",
32 | "react-use-flexsearch": "^0.1.1",
33 | "typescript": "^4.0.3",
34 | "yaml": "^1.10.0"
35 | },
36 | "devDependencies": {
37 | "@types/node": "^14.11.8",
38 | "@types/react": "^16.9.52",
39 | "@types/react-dom": "^16.9.8",
40 | "@types/react-helmet": "^6.1.0",
41 | "@typescript-eslint/eslint-plugin": "^4.4.1",
42 | "@typescript-eslint/parser": "^4.4.1",
43 | "eslint": "^7.11.0",
44 | "gh-pages": "^3.1.0"
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/src/components/Content.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 |
3 | export default ({ children }: React.PropsWithChildren>): React.ReactElement => (
4 |
120 | { children }
121 |
122 | );
123 |
--------------------------------------------------------------------------------
/src/components/Footer/index.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import { graphql, useStaticQuery } from "gatsby";
3 |
4 | import Link from "../Link";
5 |
6 | export default (): React.ReactElement => {
7 | const data = useStaticQuery(graphql`
8 | query {
9 | contentsYaml {
10 | copyright
11 | }
12 | }
13 | `);
14 |
15 | return (
16 |
56 | );
57 | };
58 |
--------------------------------------------------------------------------------
/src/components/Header/Branding.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import { IoIosArrowForward } from "react-icons/io";
3 |
4 | import Link from "../Link";
5 |
6 | interface HeaderBrandingProps {
7 | name: string;
8 | logo?: string;
9 | }
10 |
11 | export default ({ name, logo }: HeaderBrandingProps): React.ReactElement => (
12 |
17 |
18 | {
19 | logo
20 | ? 
30 | : name
31 | }
32 |
33 |
34 |
41 | ): React.ReactElement => (
12 |
23 | { children }
24 |
25 | );
26 |
--------------------------------------------------------------------------------
/src/components/Header/Links.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import { FiCompass, FiGithub, FiTwitter } from "react-icons/fi";
3 |
4 | import HeaderLink from "./Link";
5 | import ThemeToggle from "./ThemeToggle";
6 |
7 | interface HeaderLinksProps {
8 | repository: string;
9 | twitter: string;
10 | website: string;
11 | }
12 |
13 | export default ({
14 | repository,
15 | twitter,
16 | website,
17 | }: HeaderLinksProps): React.ReactElement => (
18 |
33 |
37 |
39 | )
40 | }
41 | {
42 | repository && (
43 |
44 |
46 | )
47 | }
48 | {
49 | twitter && (
50 |
51 |
53 | )
54 | }
55 |
56 | );
57 |
--------------------------------------------------------------------------------
/src/components/Header/Search.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import { graphql, useStaticQuery } from "gatsby";
3 | import { useFlexSearch } from "react-use-flexsearch";
4 | import { FiSearch, FiX } from "react-icons/fi";
5 |
6 | import Link from "../Link";
7 |
8 | export default (): React.ReactElement => {
9 | const [ query, setQuery ] = React.useState("");
10 | const [ resultQuery, setResultQuery ] = React.useState("");
11 | const data = useStaticQuery(graphql`
12 | query SearchIndexQuery {
13 | localSearchPages {
14 | index
15 | store
16 | }
17 | }
18 | `);
19 | const results = useFlexSearch(resultQuery, data.localSearchPages.index, data.localSearchPages.store);
20 |
21 | const clearQuery = () => {
22 | setQuery("");
23 | setResultQuery("");
24 | };
25 |
26 | const handleQuery = (e: React.ChangeEvent) => {
27 | setQuery(e.target.value);
28 | };
29 |
30 | const searchQuery = (e: React.KeyboardEvent) => {
31 | if (e.key.toLowerCase() === "enter") {
32 | setResultQuery(query);
33 | }
34 | };
35 |
36 | return (
37 |
47 |
51 |
7 | {
8 | ({ theme, toggleTheme }: { theme: string; toggleTheme: (theme: string) => void }) => (
9 | toggleTheme(theme === "light" ? "dark" : "light") }
19 | >
20 | { theme === "dark" ?
25 | );
26 |
--------------------------------------------------------------------------------
/src/components/Header/index.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import { graphql, useStaticQuery } from "gatsby";
3 |
4 | import Branding from "./Branding";
5 | import HeaderLink, { HeaderLinkProps } from "./Link";
6 | import Links from "./Links";
7 | import Search from "./Search";
8 |
9 | export default (): React.ReactElement => {
10 | const data = useStaticQuery(graphql`
11 | query HeaderLogoQuery {
12 | contentsYaml {
13 | title
14 | logo
15 | repository
16 | twitter
17 | website
18 | links {
19 | name
20 | link
21 | }
22 | }
23 | }
24 | `);
25 |
26 | return (
27 |
34 |
37 |
46 |
91 | { node.name }
92 |
93 | ))
94 | }
95 |
96 |
100 | );
101 | };
102 |
--------------------------------------------------------------------------------
/src/components/Link.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import { Link as GatsbyLink } from "gatsby";
3 |
4 | interface LinkProps {
5 | to: string;
6 | [key: string]: string;
7 | }
8 |
9 | export default ({ children, to, ...props }: React.PropsWithChildren): React.ReactElement => {
10 | if (to === "") {
11 | return (
12 |
13 | { children }
14 |
15 | );
16 | }
17 |
18 | const internal = /^\/(?!\/)/.test(to);
19 |
20 | if (internal) {
21 | return (
22 |
23 | { children }
24 |
25 | );
26 | }
27 |
28 | return (
29 |
35 | { children }
36 |
37 | );
38 | };
39 |
--------------------------------------------------------------------------------
/src/components/Logo.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 |
3 | interface ILogoProps {
4 | size?: number;
5 | }
6 |
7 | export default (props: ILogoProps): React.ReactElement => (
8 | 
14 | );
15 |
--------------------------------------------------------------------------------
/src/components/Main.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 |
3 | import Content from "./Content";
4 | import Sidebar from "./Sidebar";
5 | import SidebarToggle from "./SidebarToggle";
6 |
7 | export default ({ children }: React.PropsWithChildren>): React.ReactElement => {
8 | const [ sidebarStatus, setSidebarStatus ] = React.useState(false);
9 |
10 | return (
11 |
19 |
21 | { children }
22 |
23 | setSidebarStatus(!sidebarStatus) } />
24 |
25 | );
26 | };
27 |
--------------------------------------------------------------------------------
/src/components/Sidebar.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import { graphql, useStaticQuery } from "gatsby";
3 |
4 | import Link from "./Link";
5 |
6 | interface SidebarProps {
7 | open: boolean;
8 | }
9 |
10 | interface SidebarNavigationLinkQuery {
11 | name: string;
12 | link: string;
13 | }
14 |
15 | interface SidebarNavigationQuery {
16 | links: SidebarNavigationLinkQuery[];
17 | section: string;
18 | }
19 |
20 | interface SidebarQuery {
21 | contentsYaml: {
22 | navigation: SidebarNavigationQuery[];
23 | };
24 | }
25 |
26 | export default ({ open }: SidebarProps): React.ReactElement => {
27 | const data: SidebarQuery = useStaticQuery(graphql`
28 | query SidebarQuery {
29 | contentsYaml {
30 | navigation {
31 | links {
32 | name
33 | link
34 | }
35 | section
36 | }
37 | }
38 | }
39 | `);
40 |
41 | return (
42 |
58 |
119 |
120 | );
121 | };
122 |
--------------------------------------------------------------------------------
/src/components/SidebarToggle.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import { FiMenu, FiX } from "react-icons/fi";
3 |
4 | interface ISidebarToggleProps {
5 | open: boolean;
6 | onClickHandler: (event: React.MouseEvent) => void;
7 | }
8 |
9 | export default ({ open, onClickHandler }: React.PropsWithChildren): React.ReactElement => (
10 |
30 | { open ? ;
5 | headComponents: React.Component[];
6 | bodyAttributes: Record;
7 | preBodyComponents: React.Component[];
8 | body: string;
9 | postBodyComponents: React.Component[];
10 | }
11 |
12 | export default (
13 | props: React.PropsWithChildren,
14 | ): React.ReactElement => (
15 |
16 |
17 |
18 |
19 |
23 |
24 |
25 |
26 |
31 |
37 |
43 |
49 |
50 |
51 |
52 |
53 | { props.headComponents }
54 |
55 |
56 | { props.preBodyComponents }
57 |
62 | { props.postBodyComponents }
63 |
64 |
65 | );
66 |
--------------------------------------------------------------------------------
/src/layouts/index.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import { graphql, useStaticQuery } from "gatsby";
3 | import Helmet from "react-helmet";
4 |
5 | import Footer from "../components/Footer";
6 | import Header from "../components/Header";
7 | import Main from "../components/Main";
8 |
9 | import "../styles/normalize.css";
10 | import "../styles/fonts.css";
11 | import "../styles/base.css";
12 |
13 | interface DefaultLayoutProps {
14 | title: string;
15 | description: string;
16 | }
17 |
18 | export default ({ children, title, description }: React.PropsWithChildren): React.ReactElement => {
19 | const data = useStaticQuery(graphql`
20 | query DefaultLayoutQuery {
21 | contentsYaml {
22 | title
23 | description
24 | }
25 | }
26 | `);
27 |
28 | return (
29 | <>
30 |
35 |
36 |
37 |
39 | { children }
40 |
41 |
42 |
43 | );
44 | };
45 |
--------------------------------------------------------------------------------
/src/styles/base.css:
--------------------------------------------------------------------------------
1 | :root {
2 | --black: #000000;
3 | --white: #ffffff;
4 |
5 | --gray1: #8e8e93;
6 | --gray2: #aeaeb2;
7 | --gray3: #c7c7cc;
8 | --gray4: #d1d1d6;
9 | --gray5: #e5e5ea;
10 | --gray6: #f2f2f7;
11 |
12 | --error: #ff3b30;
13 | --info: #5ac8fa;
14 | --success: #34c759;
15 | --warning: #ffcc00;
16 |
17 | --accent: #007aff;
18 | --accent-alt: #0a84ff;
19 |
20 | --transition-duration: 0.25s;
21 | --transition-function: ease-out;
22 | }
23 |
24 | body {
25 | --background: var(--white);
26 | --text: var(--black);
27 | }
28 |
29 | body.dark {
30 | --gray1: #8e8e93;
31 | --gray2: #636366;
32 | --gray3: #48484a;
33 | --gray4: #3a3a3c;
34 | --gray5: #2c2c2e;
35 | --gray6: #1c1c1e;
36 |
37 | --background: var(--black);
38 | --text: var(--white);
39 |
40 | --accent: #0a84ff;
41 | --accent-alt: #007aff;
42 | }
43 |
44 | *,
45 | ::before,
46 | ::after {
47 | box-sizing: border-box;
48 | text-rendering: optimizeLegibility;
49 | -webkit-font-smoothing: subpixel-antialiased;
50 | -moz-osx-font-smoothing: grayscale;
51 | transition: background var(--transition-duration) var(--transition-function), border-color var(--transition-duration) var(--transition-function), color var(--transition-duration) var(--transition-function);
52 | }
53 |
54 | body {
55 | color: var(--text);
56 | background-color: var(--background);
57 | overflow-x: none;
58 | }
59 |
60 | a,
61 | button,
62 | input,
63 | textarea {
64 | outline: 0;
65 | border: none;
66 | color: inherit;
67 | }
68 |
69 | a {
70 | text-decoration: none;
71 | transition: color var(--transition-duration) var(--transition-function);
72 | cursor: pointer;
73 | }
74 |
75 | button:disabled,
76 | input:disabled,
77 | textarea:disabled {
78 | cursor: not-allowed;
79 | }
80 |
81 | button {
82 | padding: 10px 25px;
83 | border-radius: 3px;
84 | background-color: var(--accent);
85 | color: var(--white);
86 | font-weight: 500;
87 | box-shadow: 0 3px 15px -5px rgba(0, 0, 0, 0.3);
88 | transition: background-color var(--transition-duration)
89 | var(--transition-function);
90 | cursor: pointer;
91 | }
92 | button:not(:disabled):hover {
93 | background-color: var(--accent-alt);
94 | }
95 |
--------------------------------------------------------------------------------
/src/styles/fonts.css:
--------------------------------------------------------------------------------
1 | @font-face {
2 | font-family: "Inter var";
3 | font-weight: 100 900;
4 | font-display: swap;
5 | font-style: normal;
6 | font-named-instance: "Regular";
7 | src: url("../fonts/Inter.var.woff2") format("woff2");
8 | }
9 |
10 | @font-face {
11 | font-family: "JetBrains Mono";
12 | font-weight: 100 900;
13 | font-display: swap;
14 | font-style: normal;
15 | font-named-instance: "Regular";
16 | src: url("../fonts/JetBrainsMono-Regular.woff2") format("woff2");
17 | }
18 |
19 | body,
20 | button,
21 | input {
22 | font-family: "Inter var", -apple-system, BlinkMacSystemFont, "Helvetica Neue",
23 | Helvetica, Arial, sans-serif;
24 | }
25 |
26 | @supports (font-variation-settings: normal) {
27 | html,
28 | button,
29 | input {
30 | font-family: "Inter var", -apple-system, BlinkMacSystemFont,
31 | "Helvetica Neue", Helvetica, Arial, sans-serif;
32 | font-size: 15px;
33 | }
34 | }
35 |
36 | code {
37 | font-family: "JetBrains Mono", Menlo, Consolas, Courier, monospace;
38 | }
39 |
40 | code[class*="language-"],
41 | pre[class*="language-"] {
42 | font-family: "JetBrains Mono", Menlo, Consolas, Courier, monospace;
43 | }
44 |
--------------------------------------------------------------------------------
/src/styles/normalize.css:
--------------------------------------------------------------------------------
1 | /*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */
2 | html{line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0}main{display:block}h1{font-size:2em;margin:0.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace, monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace, monospace;font-size:1em}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-0.25em}sup{top:-0.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}[type="button"],[type="reset"],[type="submit"],button{-webkit-appearance:button}[type="button"]::-moz-focus-inner,[type="reset"]::-moz-focus-inner,[type="submit"]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type="button"]:-moz-focusring,[type="reset"]:-moz-focusring,[type="submit"]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:0.35em 0.75em 0.625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type="checkbox"],[type="radio"]{box-sizing:border-box;padding:0}[type="number"]::-webkit-inner-spin-button,[type="number"]::-webkit-outer-spin-button{height:auto}[type="search"]{-webkit-appearance:textfield;outline-offset:-2px}[type="search"]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}template{display:none}[hidden]{display:none}
--------------------------------------------------------------------------------
/src/templates/page.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import { graphql } from "gatsby";
3 |
4 | import Layout from "../layouts/index";
5 |
6 | interface PageQuery {
7 | data: {
8 | markdownRemark: {
9 | frontmatter: {
10 | title: string;
11 | description: string;
12 | };
13 | html: string;
14 | };
15 | };
16 | }
17 |
18 | export default (props: React.PropsWithChildren): React.ReactElement => (
19 |
23 | { props.data.markdownRemark.frontmatter.title }
24 | { props.data.markdownRemark.frontmatter.description }
25 |
26 |
27 |
28 | );
29 |
30 | export const query = graphql`
31 | query($slug: String!) {
32 | markdownRemark(fields: { slug: { eq: $slug } }) {
33 | html
34 | frontmatter {
35 | title
36 | description
37 | }
38 | }
39 | }
40 | `;
41 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compileOnSave": true,
3 | "compilerOptions": {
4 | "alwaysStrict": true,
5 | "diagnostics": true,
6 | "emitBOM": true,
7 | "esModuleInterop": true,
8 | "forceConsistentCasingInFileNames": true,
9 | "jsx": "preserve",
10 | "lib": [ "dom", "dom.iterable", "scripthost", "es5", "es6", "es7", "esnext" ],
11 | "module": "CommonJS",
12 | "moduleResolution": "Node",
13 | "newLine": "lf",
14 | "noErrorTruncation": true,
15 | "noImplicitAny": true,
16 | "noImplicitThis": true,
17 | "noUnusedLocals": true,
18 | "noUnusedParameters": true,
19 | "outDir": "build",
20 | "preserveWatchOutput": true,
21 | "removeComments": true,
22 | "resolveJsonModule": true,
23 | "rootDir": "src",
24 | "sourceMap": true,
25 | "strictBindCallApply": true,
26 | "strictNullChecks": true,
27 | "strictFunctionTypes": true,
28 | "strictPropertyInitialization": true,
29 | "target": "esnext"
30 | },
31 | "exclude": [
32 | "node_modules"
33 | ],
34 | "include": [
35 | "./src/**/*"
36 | ],
37 | "typeRoots" : [
38 | "./typings"
39 | ]
40 | }
41 |
--------------------------------------------------------------------------------