@docfy/ember 0.9.0 → 0.10.0

package/docs/components/docfy-output.md

@@ -1,34 +0,0 @@
----
-order: 1
-category: components
-title: <DocfyOutput>
----
-
-# {{"<DocfyOutput>"}}
-
-This component exposes some of the result data from the build that you can use
-to render, for example, a sidebar navigation, "on this page" section, and more.
-
-Depending on the arguments you pass to the component, the output could be one of
-the following values:
-
-- `NestedPageMetadata`
-- `PageMetadata[]`
-- `PageMetadata`
-- `undefined`
-
-To learn more about each data type, please refer to the API docs.
-
-Below you can see several examples of what is possible to build using this component.
-
-# API
-
-This component has a few different options that are used to filter what the
-returning value should be. Here is the arguments this component accepts.
-
-| Argument          | Description                                           | Type                     | Default Value |
-| ----------------- | ----------------------------------------------------- | ------------------------ | ------------- |
-| `@type`           | If the result should be a flat list or nested         | `'flat'` \| `'nested'`   | `'nested'`    |
-| `@fromCurrentURL` | If the result should be filtered from the current URL | `boolean` \| `undefined` |               |
-| `@url`            | Find the page definition for the given URL            | `string` \| `undefined`  |               |
-| `@scope`          | If the result should be filtered by an scope name     | `string` \| `undefined`  |               |

package/docs/components/docfy-previous-and-next-page-demo/scope.md

@@ -1,26 +0,0 @@
-# Scoping
-
-This example passes the argument `@scope` to the component.
-
-```hbs template
-<DocfyPreviousAndNextPage @scope="docs" as |previous next|>
-  <div>
-    {{#if previous}}
-      <div class="text-sm">Previous</div>
-
-      <DocfyLink @to={{previous.url}} class="text-xl text-blue-500">
-        {{previous.title}}
-      </DocfyLink>
-    {{/if}}
-  </div>
-  <div>
-    {{#if next}}
-      <div class="text-sm">Next</div>
-
-      <DocfyLink @to={{next.url}} class="text-xl text-blue-500">
-        {{next.title}}
-      </DocfyLink>
-    {{/if}}
-  </div>
-</DocfyPreviousAndNextPage>
-```

package/docs/components/docfy-previous-and-next-page-demo/simple.md

@@ -1,24 +0,0 @@
-# Simple usage
-
-```hbs template
-<DocfyPreviousAndNextPage as |previous next|>
-  <div>
-    {{#if previous}}
-      <div class="text-sm">Previous</div>
-
-      <DocfyLink @to={{previous.url}} class="text-xl text-blue-500">
-        {{previous.title}}
-      </DocfyLink>
-    {{/if}}
-  </div>
-  <div>
-    {{#if next}}
-      <div class="text-sm">Next</div>
-
-      <DocfyLink @to={{next.url}} class="text-xl text-blue-500">
-        {{next.title}}
-      </DocfyLink>
-    {{/if}}
-  </div>
-</DocfyPreviousAndNextPage>
-```

package/docs/components/docfy-previous-and-next-page.md

@@ -1,21 +0,0 @@
----
-order: 3
-category: components
-title: <DocfyPreviousAndNextPage>
----
-
-# {{"<DocfyPreviousAndNextPage>"}}
-
-This component yields the previous and next page (`PageMetadata`) if it exists.
-The component accepts a single argument called `scope`. It is used to narrow the
-pages that it can link as previous and next.
-
-Scoping the pages is useful if you are building different sections of your docs site;
-for example, one section is "Documentation", and another is "Tutorials". This feature
-would prevent linking to a page in tutorials from a documentation page.
-
-# API
-
-| Argument | Description                  | Type                    | Default Value |
-| -------- | ---------------------------- | ----------------------- | ------------- |
-| `@scope` | Filter links by a scope name | `string` \| `undefined` |               |

package/docs/configuration.md

@@ -1,57 +0,0 @@
----
-order: 2
----
-
-# Configuration
-
-Docfy has a set of options you can configure and might have read about them
-[here](../../../docs/configuration.md). You might have been wondering how
-to set these options in the Ember app context.
-
-The Docfy integration with Ember reads a file named `.docfy-config.js` from the
-root of your app to set the config.
-
-In this file, you can add any Remark Plugins, add markdown file sources, and more.
-
-Below is a example of a configuration file.
-
-```js
-// .docfy-config.js
-
-const path = require('path');
-const autolinkHeadings = require('remark-autolink-headings');
-const highlight = require('remark-highlight.js');
-const codeImport = require('remark-code-import');
-
-module.exports = {
-  remarkPlugins: [
-    [autolinkHeadings, { behavior: 'wrap' }],
-    codeImport,
-    highlight
-  ],
-  sources: [
-    {
-      root: path.resolve(__dirname, '../../../docs'),
-      pattern: '**/*.md',
-      urlSchema: 'manual',
-      urlPrefix: 'docs'
-    },
-    {
-      root: path.join(__dirname, 'docs'),
-      pattern: '**/*.md',
-      urlSchema: 'manual',
-      urlPrefix: 'docs/ember'
-    }
-  ],
-  labels: {
-    components: 'Components',
-    core: '@docfy/core',
-    ember: '@docfy/ember',
-    docs: 'Documentation'
-  }
-};
-```
-
-> You are not required to create this file. If Docfy cannot find it, we will
-> use a default configuration. By default markdown files are read from `docs`
-> in the root of the Ember app.

package/docs/index.md

@@ -1,165 +0,0 @@
----
-order: 1
-title: Getting Started
----
-
-# Getting Started with Ember
-
-Let's get started by creating a new Ember app and adding Docfy to it. For adding
-to existing apps, jump to the step after creating the app.
-
-## Generate the App
-
-There isn't anything special here; just create the ember app and remove the
-`<WelcomePage />` from `application.hbs`.
-
-```
-ember new docfy-example
-cd docfy-example
-```
-
-## Add Docfy dependency
-
-```
-yarn add -D @docfy/ember
-// or
-npm install --dev @docfy/ember
-```
-
-## Add Docfy Routes
-
-Docfy has a function that adds all the routes to your Ember app. It understands
-the output of Docfy Core and process all the page URLs to add their paths to the Ember app.
-
-In your `app/router.js` import `import { addDocfyRoutes } from '@docfy/ember';`
-then add `addDocfyRoutes(this)` to the Router Map. The final result looks like the following:
-
-```js
-import EmberRouter from '@ember/routing/router';
-import config from './config/environment';
-import { addDocfyRoutes } from '@docfy/ember';
-
-export default class Router extends EmberRouter {
-  location = config.locationType;
-  rootURL = config.rootURL;
-}
-
-Router.map(function () {
-  addDocfyRoutes(this);
-});
-```
-
-## Add Markdown Files
-
-Let's add some markdown files so that we can see it in our app.
-
-Create a folder named `docs` in the root of your app then place the following content to `index.md`.
-
-```md
-# Hello from my docs site using Docfy
-
-**Lorem Ipsum** is simply dummy text of the printing and typesetting industry.
-Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when
-an unknown printer took a galley of type and scrambled it to make a type specimen book
-```
-
-Let's add another file called `installation.md`.
-
-```md
-# Installation
-
-Follow the steps below to install my app:
-
-1. `yarn install`
-2. `yarn start`
-3. Done.
-```
-
-## Start the Server
-
-You can now start the Ember server and visit the docs page.
-
-```sh
-ember serve
-```
-
-The server will be running on port `4200`, and the docs path will be `/docs`.
-Here is the full URL: [http://localhost:4200/docs](http://localhost:4200/docs).
-
-To visit the second document we created earlier, you can access
-[http://localhost:4200/docs/installation](http://localhost:4200/docs/installation).
-
-That's it, you now have a full working app with Docfy generating pages from
-markdown files.
-
-## Add a Sidebar
-
-Docfy provides several low-level components that help you build the documentation site.
-Docfy does not offer any styles by default; our philosophy is to provide all the
-pieces for you to develop your docs site with your styles. This approach is perfect
-for building design systems that use the styles from your design in your docs.
-
-We can add a `docs` template that will be used when rendering any documentation
-page because of Ember's routing and templating patterns.
-
-In your `app/templates/docs.hbs` add the following:
-
-```hbs
-<DocfyOutput @scope="docs" as |node|>
-  <ul>
-    {{#each node.pages as |page|}}
-      <li>
-        <DocfyLink @to={{page.url}}>
-          {{page.title}}
-        </DocfyLink>
-      </li>
-    {{/each}}
-  </ul>
-</DocfyOutput>
-
-<div>
-  {{outlet}}
-</div>
-```
-
-This example uses two components, `DocfyOutput` and `DocfyLink`. It is also
-the simplest navigation component we can build, ignoring any nested sections
-you might define. You can learn more about these components and their capabilities
-in their respective documentation page.
-
-## Add Previous and Next Page Links
-
-Documentation sites usually have a previous and next page link. Docfy provides a component that gives you the ability to add this feature.
-
-At the end of the `docs.hbs` file, add the following:
-
-```hbs
-<DocfyPreviousAndNextPage as |previous next|>
-  <div>
-    {{#if previous}}
-      Previous:
-
-      <DocfyLink @to={{previous.url}}>
-        {{previous.title}}
-      </DocfyLink>
-    {{/if}}
-  </div>
-  <div>
-    {{#if next}}
-      Next:
-
-      <DocfyLink @to={{next.url}}>
-        {{next.title}}
-      </DocfyLink>
-    {{/if}}
-  </div>
-</DocfyPreviousAndNextPage>
-```
-
-## Other Features
-
-Docfy has other abilities that we haven't covered here. For example, we can build
-a section that displays "on this page", which lists all the headings in the document.
-Another example is adding a link to edit the markdown file on GitHub. Another
-useful feature is the ability to demo components out of markdown files. These
-features are covered throughout the docs.

package/docs/writing-demos-demo/demo1.md

@@ -1,18 +0,0 @@
-# Demo of Docfy Demos :D
-
-This is a cool feature of Docfy. It is perfect for documenting design systems and
-component libraries.
-
-> Note that this text was extracted from the markdown demo file.
-
-```hbs template
-This is my Demo: <DocfyLink @to={{this.url}}>My Link</DocfyLink>
-```
-
-```js component
-import Component from '@glimmer/component';
-
-export default class MyDemo extends Component {
-  url = '/docs';
-}
-```

package/docs/writing-demos.md

@@ -1,109 +0,0 @@
----
-order: 3
----
-
-# Writing Demos
-
-Docfy has a concept of "demo" markdown files. It allows you to write code in
-markdown and have them be extracted as executable code in the host app. You can
-learn more about the file location rules in [Writing Markdown - Demos](../../../docs/writing-markdown.md#demos).
-
-In the context of Ember, all demos are extracted as components. These components
-can have a template, component, and style code block. Components can also be
-template only components by only specifying the HBS template.
-
-> Note that styles will be extracted as a co-located file with the component,
-> it would only work if your host app is using [Ember CSS Modules](https://github.com/salsify/ember-css-modules)
-> or something similar.
-
-Below you can see how a demo markdown file looks like.
-
-```md file=writing-demos-demo/demo1.md
-
-```
-
-The demo will be inserted into the owner file as a new section called "Examples";
-you can see it below.
-
-Please note that you must pass a metadata to the code block, it can be seen
-after the file type in the example above. The meta is used to identify the purpose
-of the code block. The possible values are `component`, `template`, and `styles`.
-
-> You can write TypeScript for the component JS as well, if your host app is
-> configured to support it.
-
-## Preview Template
-
-When writing documentation in Ember apps, we might want to write some template
-code to demonstrate how to use a component whilst also having the code
-executed to embed the same template into the rendered markdown. Creating a
-demo markdown might be too much of an effort; for this purpose, Docfy has
-another feature called `preview-template`. It will extract the template from
-the markdown code block and create a component backed by an empty Glimmer
-component class to provide a `this` context so helpers such as `mut` or `set`
-can be used within the demonstration. It will also add the code snippet so
-users can see the code.
-
-Below is an example of how it works:
-
-````md
-```hbs preview-template
-Click in the link to navigate to the home page: <DocfyLink @to="/">Home</DocfyLink>
-```
-````
-
-And here you can see how it looks like when rendered:
-
-```hbs preview-template
-Click in the link to navigate to the home page: <DocfyLink @to="/">Home</DocfyLink>
-```
-
-## Manual Insertion
-
-To make getting started with Docfy as simple as possible, by default demos will
-be automatically inserted into the owner file under a new section called
-"Examples" before the second heading of the page.
-
-If you want more control over how demos are inserted into the page, you can
-declare `manualDemoInsertion` in a markdown page's frontmatter.
-
-```
----
-title: Document with many examples
-manualDemoInsertion: true
----
-```
-
-When a page is using `manualDemoInsertion`, by default no demos are inserted
-into the page. Instead, you must provide markers in your markdown that will be
-replaced. They follow the form `[[demo:name-of-demo]]`.
-
-```md
-# Title here
-
-The demo will be inserted after this line.
-
-[[demo:demo1]]
-
-And the prose of the document will continue exactly how the author wishes.
-```
-
-Sometimes as an author, you want control over where in the page demos will be
-inserted, but you don't need to control this location demo by demo. As a
-shorthand, you can provide the `[[demos-all]]` marker to insert all demos.
-
-```md
-# Title here
-
-All demos go here.
-
-[[demos-all]]
-
-Below is the equivalent if you had to mark all demos individually.
-
-[[demo:demo1]]
-
-[[demo:demo2]]
-
-[[demo:demo3]]
-```

package/dummy-docs/README.md

@@ -1,140 +0,0 @@
-# Welcome to Docfy
-
-This project is on GitHub.
-
-![GitHub](./github-icon.png)
-
-## h2 Heading
-
-### h3 Heading
-
-#### h4 Heading
-
-##### h5 Heading
-
-###### h6 Heading
-
-## Paragraphs
-
-I really like using Markdown.
-
-I think I'll use it to format all of my documents from now on.
-
-"Smartypants, double quotes" and 'single quotes'
-
-## Emphasis
-
-**This is bold text**
-
-**This is bold text**
-
-_This is italic text_
-
-_This is italic text_
-
-~~Strikethrough~~
-
-## Blockquotes
-
-> Dorothy followed her through many of the beautiful rooms in her castle.
-
-### Blockquotes with Multiple Paragraphs
-
-> Dorothy followed her through many of the beautiful rooms in her castle.
->
-> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
-
-### Nested Blockquotes
-
-> Dorothy followed her through many of the beautiful rooms in her castle.
->
-> > The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
-
-## Lists
-
-Unordered
-
-- Create a list by starting a line with `+`, `-`, or `*`
-- Sub-lists are made by indenting 2 spaces:
-  - Marker character change forces new list start:
-    - Ac tristique libero volutpat at
-    * Facilisis in pretium nisl aliquet
-    - Nulla volutpat aliquam velit
-- Very easy!
-
-Ordered
-
-1. Lorem ipsum dolor sit amet
-2. Consectetur adipiscing elit
-3. Integer molestie lorem at massa
-
-4. You can use sequential numbers...
-5. ...or keep all the numbers as `1.`
-
-Start numbering with offset:
-
-57. foo
-1. bar
-
-## Code
-
-Inline `code`
-
-Indented code
-
-    // Some comments
-    line 1 of code
-    line 2 of code
-    line 3 of code
-
-Block code "fences"
-
-```
-Sample text here...
-```
-
-Syntax highlighting
-
-```js
-var foo = function (bar) {
-  return bar++;
-};
-
-console.log(foo(5));
-```
-
-## Tables
-
-| Option | Description                                                               |
-| ------ | ------------------------------------------------------------------------- |
-| data   | path to data files to supply the data that will be passed into templates. |
-| engine | engine to be used for processing templates. Handlebars is the default.    |
-| ext    | extension to be used for dest files.                                      |
-
-Right aligned columns
-
-| Option |                                                               Description |
-| -----: | ------------------------------------------------------------------------: |
-|   data | path to data files to supply the data that will be passed into templates. |
-| engine |    engine to be used for processing templates. Handlebars is the default. |
-|    ext |                                      extension to be used for dest files. |
-
-## Links
-
-[link text](http://dev.nodeca.com)
-
-[link with title](http://nodeca.github.io/pica/demo/ 'title text!')
-
-Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
-
-## Images
-
-![Minion](https://octodex.github.com/images/minion.png)
-
-Like links, Images also have a footnote style syntax
-
-![Alt text][id]
-
-With a reference later in the document defining the URL location:
-
-[id]: https://octodex.github.com/images/dojocat.jpg 'The Dojocat'

package/dummy-docs/installation.md

@@ -1,14 +0,0 @@
----
-order: 1
----
-
-# Installation
-
-```sh
-
-# Using npm
-npm install --save-dev @docfy/ember
-
-# Using Yarn
-yarn add --dev @docfy/ember
-```

package/dummy-docs/introduction.md

@@ -1,30 +0,0 @@
----
-order: 0
----
-
-# Introduction
-
-Lorem markdownum animaeque obsedit adversam, saevi sed resupina tenuesque levius
-tenenti utque. Cornibus et opes crudelia primus procul alvum exit: dum frondes!
-Cornibus e, putat procul nostro erat cunctantem munus inventus quod.
-
-- Unus frondes
-- Gelida vos cultus vada dicta sunt lacerto
-- Utque meum referam
-
-## How it works
-
-Poterisne perque Threiciis angue adlevat, parari non canisve mane opemque et
-inpar corpora suspiria traxit Teucri vulgique monte?
-
-## Show me some code
-
-Byblis vobisque me venerisque possem **una** nihil volui desiderioque quam
-parilique quosque victor contingere urbem monendo. Meae est precor moenibus.
-
-1. Suis cum ille
-2. Recipit precor in opus quam Philyreia potest
-
-```js
-import Docfy from '@docfy/core';
-```

package/dummy-docs/overview.md

@@ -1,19 +0,0 @@
----
-order: 2
----
-
-# Overview
-
-Byblis vobisque me venerisque possem **una** nihil volui desiderioque quam
-parilique quosque victor contingere urbem monendo. Meae est precor moenibus.
-
-1. Suis cum ille
-2. Repperit undique sic aras ad passu vocant
-3. Recipit precor in opus quam Philyreia potest
-4. Sparsas temptat peregit susceptaque femori ferox grande
-
-Sed ver Eumenidum in duorum quis anhelatos, currum voce? **Thracum** servabat
-matris cornua positis certo.
-
-Please check the [introduction on how it
-works `inline code`](./introduction.md#how-it-works).

package/dummy-docs/packages/core/helpers/genereate-flat-output.md

@@ -1,10 +0,0 @@
----
-category: core
-subcategory: helpers
----
-
-# genereateFlatOutput
-
-Lorem markdownum animaeque obsedit adversam, saevi sed resupina tenuesque levius
-tenenti utque. Cornibus et opes crudelia primus procul alvum exit: dum frondes!
-Cornibus e, putat procul nostro erat cunctantem munus inventus quod.

package/dummy-docs/packages/core/helpers/genereate-nested-output.md

@@ -1,12 +0,0 @@
----
-category: core
-subcategory: helpers
----
-
-# genereateNestedOutput
-
-[Link](../overview.md).
-
-Lorem markdownum animaeque obsedit adversam, saevi sed resupina tenuesque levius
-tenenti utque. Cornibus et opes crudelia primus procul alvum exit: dum frondes!
-Cornibus e, putat procul nostro erat cunctantem munus inventus quod.