working on docs

docs/README.md

@@ -14,7 +14,7 @@ We are rebuilding react-native-navigation.
 - [v2 Roadmap](#v2-roadmap)
 - [v1 vs v2 feature comparison](#v1-vs-v2-feature-comparison)
 - [Documentation](https://wix.github.io/react-native-navigation/v2/)
-- [Contributing](/docs/docs/WorkingLocally.md)
+- [Contributing](/docs/WorkingLocally.md)
 
 ## Why Rebuild react-native-navigation?
 

docs/_sidebar.md

@@ -1,12 +1,13 @@
+- [Home](/)
 - Getting Started
   - [Installing](/docs/Installing)
   - [Working Locally](/docs/WorkingLocally)
   - [Usage](/docs/Usage)
+- [API](/api/README)
 - Guide
   - [Top Level](/docs/top-level-api)
   - [Screen](/docs/screen-api)
   - [Layout Types](/docs/layout-types)
   - [Styling](/docs/styling)
 - Migration from v1
-  - [Top Level](/docs/top-level-api-migration)
-  
+  - [Top Level](/docs/top-level-api-migration)

docs/api/Navigation.md

@@ -1,188 +1,160 @@
 # Navigation
 
-## Properties
+## Element
 
-- Element (`React.ComponentType<object>`)
+`Element (React.ComponentType<object>)`
 
-## Methods
+---
 
-### `registerComponent(componentName: string, getComponentClassFunc: ComponentProvider): void`
+## registerComponent
 
-[source](/lib/src//Navigation.ts#52)
+`registerComponent(componentName: string, getComponentClassFunc: ComponentProvider): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L52)
 
 Every navigation component in your app must be registered with a unique name.
 The component itself is a traditional React component extending React.Component.
 
-#### Arguments
-- componentName (`string`)
-- getComponentClassFunc (`ComponentProvider`)
+---
 
-#### Returns
-- (`void`)
+## setRoot
 
-### `setRoot(layout: any): Promise<any>`
+`setRoot(layout: any): Promise<any>`
 
-[source](/lib/src//Navigation.ts#59)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L59)
 
 Reset the app to a new layout
 
-#### Arguments
-- layout (`any`)
+---
 
-#### Returns
-- (`Promise<any>`)
+## setDefaultOptions
 
-### `setDefaultOptions(options: any): void`
+`setDefaultOptions(options: any): void`
 
-[source](/lib/src//Navigation.ts#66)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L66)
 
 Set default options to all screens. Useful for declaring a consistent style across the app.
 
-#### Arguments
-- options (`any`)
+---
 
-#### Returns
-- (`void`)
+## mergeOptions
 
-### `mergeOptions(componentId: string, options: any): void`
+`mergeOptions(componentId: string, options: any): void`
 
-[source](/lib/src//Navigation.ts#73)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L73)
 
 Change a component's navigation options
 
-#### Arguments
-- componentId (`string`)
-- options (`any`)
+---
 
-#### Returns
-- (`void`)
+## showModal
 
-### `showModal(layout: any): Promise<any>`
+`showModal(layout: any): Promise<any>`
 
-[source](/lib/src//Navigation.ts#80)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L80)
 
 Show a screen as a modal.
 
-#### Arguments
-- layout (`any`)
+---
 
-#### Returns
-- (`Promise<any>`)
+## dismissModal
 
-### `dismissModal(componentId: string): Promise<any>`
+`dismissModal(componentId: string): Promise<any>`
 
-[source](/lib/src//Navigation.ts#87)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L87)
 
 Dismiss a modal by componentId. The dismissed modal can be anywhere in the stack.
 
-#### Arguments
-- componentId (`string`)
+---
 
-#### Returns
-- (`Promise<any>`)
+## dismissAllModals
 
-### `dismissAllModals(): Promise<any>`
+`dismissAllModals(): Promise<any>`
 
-[source](/lib/src//Navigation.ts#94)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L94)
 
 Dismiss all Modals
 
-#### Returns
-- (`Promise<any>`)
+---
+
+## push
 
-### `push(componentId: string, layout: any): Promise<any>`
+`push(componentId: string, layout: any): Promise<any>`
 
-[source](/lib/src//Navigation.ts#101)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L101)
 
 Push a new layout into this screen's navigation stack.
 
-#### Arguments
-- componentId (`string`)
-- layout (`any`)
+---
 
-#### Returns
-- (`Promise<any>`)
+## pop
 
-### `pop(componentId: string, params: any): Promise<any>`
+`pop(componentId: string, params: any): Promise<any>`
 
-[source](/lib/src//Navigation.ts#108)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L108)
 
 Pop a component from the stack, regardless of it's position.
 
-#### Arguments
-- componentId (`string`)
-- params (`any`)
+---
 
-#### Returns
-- (`Promise<any>`)
+## popTo
 
-### `popTo(componentId: string): Promise<any>`
+`popTo(componentId: string): Promise<any>`
 
-[source](/lib/src//Navigation.ts#115)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L115)
 
 Pop the stack to a given component
 
-#### Arguments
-- componentId (`string`)
+---
 
-#### Returns
-- (`Promise<any>`)
+## popToRoot
 
-### `popToRoot(componentId: string): Promise<any>`
+`popToRoot(componentId: string): Promise<any>`
 
-[source](/lib/src//Navigation.ts#122)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L122)
 
 Pop the component's stack to root.
 
-#### Arguments
-- componentId (`string`)
+---
 
-#### Returns
-- (`Promise<any>`)
+## setStackRoot
 
-### `setStackRoot(componentId: string, layout: any): Promise<any>`
+`setStackRoot(componentId: string, layout: any): Promise<any>`
 
-[source](/lib/src//Navigation.ts#129)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L129)
 
 Sets new root component to stack.
 
-#### Arguments
-- componentId (`string`)
-- layout (`any`)
+---
 
-#### Returns
-- (`Promise<any>`)
+## showOverlay
 
-### `showOverlay(layout: any): Promise<any>`
+`showOverlay(layout: any): Promise<any>`
 
-[source](/lib/src//Navigation.ts#136)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L136)
 
 Show overlay on top of the entire app
 
-#### Arguments
-- layout (`any`)
+---
 
-#### Returns
-- (`Promise<any>`)
+## dismissOverlay
 
-### `dismissOverlay(componentId: string): Promise<any>`
+`dismissOverlay(componentId: string): Promise<any>`
 
-[source](/lib/src//Navigation.ts#143)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L143)
 
 dismiss overlay by componentId
 
-#### Arguments
-- componentId (`string`)
+---
 
-#### Returns
-- (`Promise<any>`)
+## events
 
-### `events(): EventsRegistry`
+`events(): EventsRegistry`
 
-[source](/lib/src//Navigation.ts#150)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L150)
 
 Obtain the events registry instance
 
-#### Returns
-- (`EventsRegistry`)
+---
+
 

docs/api/_sidebar.md

@@ -0,0 +1,3 @@
+- [Home](/)
+- [Navigation](/api/Navigation)
+- 

docs/index.html

@@ -15,7 +15,7 @@
 
 <body>
   <div id="app">Please wait...</div>
-  <script src="//unpkg.com/docsify-copy-code/index.js"></script>
+  <script src="//unpkg.com/docsify-copy-code"></script>
   <script>
     window.$docsify = {
       name: 'React Native Navigation',
@@ -24,6 +24,7 @@
       search: 'auto',
       loadSidebar: true,
       alias: {
+        '/api/_sidebar.md': '/api/_sidebar.md',
         '/.*/_sidebar.md': '/_sidebar.md'
       },
       subMaxLevel: 2,

scripts/gen-docs/Main.ts

@@ -3,8 +3,9 @@ import { ReflectionsReader } from './ReflectionsReader';
 import { MarkdownCreator } from './MarkdownCreator';
 import * as Handlebars from 'handlebars';
 
-const MD_RELATIVE_LINK = `/lib/src/`;
+const INPUT_DIR = `${__dirname}/../../lib/src/Navigation.ts`;
 const OUTPUT_DIR = `${__dirname}/../../docs/api`;
+const SOURCE_LINK_PREFIX = `https://github.com/wix/react-native-navigation/blob/v2/lib/src`;
 const TEMPLATES_DIR = `${__dirname}/templates`;
 const TSCONFIG = JSON.parse(fs.readFileSync(`${__dirname}/../../tsconfig.json`).toString());
 
@@ -12,21 +13,22 @@ class Main {
   public run() {
     const handlebarsFn = this.setupHandlebars();
 
-    const reflection = new ReflectionsReader(TSCONFIG).read('./lib/src/Navigation.ts');
-    const markdown = new MarkdownCreator(MD_RELATIVE_LINK, handlebarsFn).create(reflection);
+    const reflection = new ReflectionsReader(TSCONFIG).read(INPUT_DIR);
+    const markdown = new MarkdownCreator(SOURCE_LINK_PREFIX, handlebarsFn).create(reflection);
 
     fs.writeFileSync(`${OUTPUT_DIR}/Navigation.md`, markdown, { encoding: 'utf8' });
   }
 
   private setupHandlebars() {
-    const mainTemplate = fs.readFileSync(`${TEMPLATES_DIR}/main.hbs`).toString();
     const classTemplate = fs.readFileSync(`${TEMPLATES_DIR}/class.hbs`).toString();
     const methodTemplate = fs.readFileSync(`${TEMPLATES_DIR}/method.hbs`).toString();
+    const propertyTemplate = fs.readFileSync(`${TEMPLATES_DIR}/property.hbs`).toString();
 
     Handlebars.registerPartial('class', classTemplate);
     Handlebars.registerPartial('method', methodTemplate);
+    Handlebars.registerPartial('property', propertyTemplate);
 
-    return Handlebars.compile(mainTemplate, { strict: true, noEscape: true });
+    return Handlebars.compile('{{> class}}', { strict: true, noEscape: true });
   }
 }
 

scripts/gen-docs/MarkdownCreator.ts

@@ -3,7 +3,7 @@ import * as Typedoc from 'typedoc';
 import * as fs from 'fs';
 
 export class MarkdownCreator {
-  constructor(private mdRelativeLinkPath: string, private handlebarsFn: HandlebarsTemplateDelegate<any>) { }
+  constructor(private sourceLinkPrefix: string, private handlebarsFn: HandlebarsTemplateDelegate<any>) { }
 
   public create(reflection: Typedoc.DeclarationReflection) {
     const context = {
@@ -23,7 +23,7 @@ export class MarkdownCreator {
       name: methodReflection.name,
       arguments: this.readArguments(methodReflection.signatures[0].parameters || []),
       returnType: methodReflection.signatures[0].type.toString(),
-      source: `${this.mdRelativeLinkPath}/${methodReflection.sources[0].fileName}#${methodReflection.sources[0].line}`,
+      source: `${this.sourceLinkPrefix}/${methodReflection.sources[0].fileName}#L${methodReflection.sources[0].line}`,
       comment: methodReflection.signatures[0].comment ? methodReflection.signatures[0].comment.shortText : ''
     }));
   }

scripts/gen-docs/ReflectionsReader.ts

@@ -1,4 +1,5 @@
 import * as Typedoc from 'typedoc';
+import { OptionsReadMode } from 'typedoc/dist/lib/utils/options';
 
 const OPTIONS = {
   excludeExternals: true,
@@ -17,8 +18,8 @@ export class ReflectionsReader {
     this.typedocApp = new Typedoc.Application({ ...OPTIONS, ...tsconfig.compilerOptions });
   }
 
-  public read(modulePath: string): Typedoc.DeclarationReflection {
-    const expandedFiles = this.typedocApp.expandInputFiles([modulePath]);
+  public read(modulePathRoot: string): Typedoc.DeclarationReflection {
+    const expandedFiles = this.typedocApp.expandInputFiles([modulePathRoot]);
     const projectReflection = this.typedocApp.convert(expandedFiles);
     // console.log(JSON.stringify(this.typedocApp.serializer.projectToObject(projectReflection)));
     const externalModule = projectReflection.getChildrenByKind(Typedoc.ReflectionKind.ExternalModule)[0];

scripts/gen-docs/templates/class.hbs

@@ -1,17 +1,14 @@
 # {{name}}
 
 {{#if properties}}
-## Properties
-
 {{#each properties}}
-- {{name}} (`{{type}}`)
+{{> property}}
 {{/each}}
 
 {{/if}}
 {{#if methods}}
-## Methods
-
 {{#each methods}}
 {{> method}}
 {{/each}}
-{{/if}}
+
+{{/if}}

scripts/gen-docs/templates/main.hbs

@@ -1 +0,0 @@
-{{> class}}

scripts/gen-docs/templates/method.hbs

@@ -1,4 +1,6 @@
-### `{{name}}({{#each arguments}}{{name}}: {{type}}{{#unless @last}}, {{/unless}}{{/each}}): {{returnType}}`
+## {{name}}
+
+`{{name}}({{#each arguments}}{{name}}: {{type}}{{#unless @last}}, {{/unless}}{{/each}}): {{returnType}}`
 
 [source]({{source}})
 
@@ -6,13 +8,5 @@
 {{comment}}
 
 {{/if}}
-{{#if arguments}}
-#### Arguments
-{{#each arguments}}
-- {{name}} (`{{type}}`)
-{{/each}}
-
-{{/if}}
-#### Returns
-- (`{{returnType}}`)
+---
 

scripts/gen-docs/templates/property.hbs

@@ -0,0 +1,5 @@
+## {{name}}
+
+`{{name}} ({{type}})`
+
+---