@docfy/ember 0.9.0 → 0.10.0

package/addon/components/docfy-output.ts

@@ -1,37 +0,0 @@
-import Component from '@glimmer/component';
-import { NestedPageMetadata, PageMetadata } from '@docfy/core/lib/types';
-import { inject as service } from '@ember/service';
-import RouterService from '@ember/routing/router-service';
-import DocfyService from '../services/docfy';
-
-interface DocfyOutputArgs {
-  type?: 'flat' | 'nested';
-  fromCurrentURL?: boolean;
-  url?: string;
-  scope?: string;
-}
-
-export default class DocfyOutput extends Component<DocfyOutputArgs> {
-  @service router!: RouterService;
-  @service docfy!: DocfyService;
-
-  get output(): NestedPageMetadata | PageMetadata[] | PageMetadata | undefined {
-    if (this.args.url) {
-      return this.docfy.findByUrl(this.args.url, this.args.scope);
-    }
-
-    if (this.args.fromCurrentURL) {
-      return this.docfy.findByUrl(this.router.currentURL, this.args.scope);
-    }
-
-    if (this.args.scope) {
-      return this.docfy.findNestedChildrenByName(this.args.scope);
-    }
-
-    if (this.args.type === 'flat') {
-      return this.docfy.flat;
-    } else {
-      return this.docfy.nested;
-    }
-  }
-}

package/addon/components/docfy-previous-and-next-page.hbs

@@ -1 +0,0 @@
-{{yield this.previous this.next}}

package/addon/components/docfy-previous-and-next-page.ts

@@ -1,20 +0,0 @@
-import Component from '@glimmer/component';
-import DocfyService from '../services/docfy';
-import { PageMetadata } from '@docfy/core/lib/types';
-import { inject as service } from '@ember/service';
-
-interface DocfyPreviousAndNextPageArgs {
-  scope?: string;
-}
-
-export default class DocfyPreviousAndNextPage extends Component<DocfyPreviousAndNextPageArgs> {
-  @service docfy!: DocfyService;
-
-  get previous(): PageMetadata | undefined {
-    return this.docfy.previousPage(this.args.scope);
-  }
-
-  get next(): PageMetadata | undefined {
-    return this.docfy.nextPage(this.args.scope);
-  }
-}

package/addon/helpers/docfy-eq.ts

@@ -1,7 +0,0 @@
-import { helper } from '@ember/component/helper';
-
-export function docfyEq(params: unknown[]): boolean {
-  return params[0] === params[1];
-}
-
-export default helper(docfyEq);

package/addon/index.ts

@@ -1,31 +0,0 @@
-import output from '@docfy/ember/output';
-import RouterDSL from '@ember/routing/-private/router-dsl';
-import { NestedPageMetadata } from '@docfy/core/lib/types';
-export { default as DocfyService } from './services/docfy';
-
-function addFromNested(context: RouterDSL, nested: NestedPageMetadata): void {
-  function add(this: RouterDSL): void {
-    nested.pages.forEach((page) => {
-      const url = page.relativeUrl;
-      if (typeof url === 'string') {
-        if (url !== '') {
-          this.route(url);
-        }
-      }
-    });
-
-    nested.children.forEach((node) => {
-      addFromNested(this, node);
-    });
-  }
-
-  if (nested.name === '/') {
-    add.call(context);
-  } else {
-    context.route(nested.name, add);
-  }
-}
-
-export function addDocfyRoutes(context: RouterDSL): void {
-  addFromNested(context, output.nested);
-}

package/addon/output.d.ts

@@ -1,13 +0,0 @@
-/*
- * The actual output.js file is generated at build time. This is only to
- * provide typing.
- */
-import { NestedPageMetadata } from '@docfy/core/lib/types';
-
-interface Output {
-  nested: NestedPageMetadata;
-}
-
-declare const output: Output;
-
-export default output;

package/addon/services/docfy.ts

@@ -1,101 +0,0 @@
-import Service from '@ember/service';
-import output from '@docfy/ember/output';
-import { NestedPageMetadata, PageMetadata } from '@docfy/core/lib/types';
-import flatNested from '../-private/flat-nested';
-import { inject as service } from '@ember/service';
-import RouterService from '@ember/routing/router-service';
-
-export default class DocfyService extends Service {
-  @service router!: RouterService;
-
-  get flat(): PageMetadata[] {
-    return flatNested(this.nested);
-  }
-
-  get nested(): NestedPageMetadata {
-    return output.nested;
-  }
-
-  get currentPage(): PageMetadata | undefined {
-    return this.findByUrl(this.router.currentURL);
-  }
-
-  findNestedChildrenByName(
-    scope: string,
-    previousNested: NestedPageMetadata | undefined | null = null
-  ): NestedPageMetadata | undefined {
-    if (previousNested === null) {
-      previousNested = this.nested;
-    }
-    const parts = scope.split('/');
-    const name = parts.shift();
-
-    const foundScope = previousNested?.children.find((item) => {
-      return item.name === name;
-    });
-
-    if (parts.length > 0) {
-      return this.findNestedChildrenByName(parts.join('/'), foundScope);
-    }
-
-    return foundScope;
-  }
-
-  findByUrl(url: string, scopeByNestedName?: string): PageMetadata | undefined {
-    let pages = this.flat;
-
-    if (typeof scopeByNestedName === 'string') {
-      pages = flatNested(this.findNestedChildrenByName(scopeByNestedName));
-    }
-
-    url = url.split('#')[0];
-
-    // Make sure to always remove the trailing slash.
-    // This is necessary for pre-rendered pages where the url always will end
-    // with an slash.
-    url = url.replace(/\/$/, '');
-
-    return pages.find((item) => {
-      return item.url === url || item.url === `${url}/`;
-    });
-  }
-
-  previousPage(scopeByNestedName?: string): PageMetadata | undefined {
-    return this.findPreviousOrNextPage(true, scopeByNestedName);
-  }
-
-  nextPage(scopeByNestedName?: string): PageMetadata | undefined {
-    return this.findPreviousOrNextPage(false, scopeByNestedName);
-  }
-
-  private findPreviousOrNextPage(
-    isPrevious: boolean,
-    scopeByNestedName?: string
-  ): PageMetadata | undefined {
-    let pages = this.flat;
-
-    if (typeof scopeByNestedName === 'string') {
-      pages = flatNested(this.findNestedChildrenByName(scopeByNestedName));
-    }
-
-    const index = pages.findIndex((page) => {
-      return page === this.currentPage;
-    });
-
-    if (index > -1) {
-      if (isPrevious) {
-        return this.flat[index - 1];
-      } else {
-        return this.flat[index + 1];
-      }
-    }
-    return undefined;
-  }
-}
-
-// DO NOT DELETE: this is how TypeScript knows how to look up your services.
-declare module '@ember/service' {
-  interface Registry {
-    docfy: DocfyService;
-  }
-}

package/app/components/docfy-demo/description.js

@@ -1 +0,0 @@
-export { default } from '@docfy/ember/components/docfy-demo/description';

package/app/components/docfy-demo/example.js

@@ -1 +0,0 @@
-export { default } from '@docfy/ember/components/docfy-demo/example';

package/app/components/docfy-demo/snippet.js

@@ -1 +0,0 @@
-export { default } from '@docfy/ember/components/docfy-demo/snippet';

package/app/components/docfy-demo/snippets.js

@@ -1 +0,0 @@
-export { default } from '@docfy/ember/components/docfy-demo/snippets';

package/app/components/docfy-demo.js

@@ -1 +0,0 @@
-export { default } from '@docfy/ember/components/docfy-demo';

package/app/components/docfy-link.js

@@ -1 +0,0 @@
-export { default } from '@docfy/ember/components/docfy-link';

package/app/components/docfy-output.js

@@ -1 +0,0 @@
-export { default } from '@docfy/ember/components/docfy-output';

package/app/components/docfy-previous-and-next-page.js

@@ -1 +0,0 @@
-export { default } from '@docfy/ember/components/docfy-previous-and-next-page';

package/app/helpers/docfy-eq.js

@@ -1 +0,0 @@
-export { default, docfyEq } from '@docfy/ember/helpers/docfy-eq';

package/app/services/docfy.js

@@ -1 +0,0 @@
-export { default } from '@docfy/ember/services/docfy';

package/components/docfy-demo/description.d.ts

@@ -1,3 +0,0 @@
-import Component from '@glimmer/component';
-export default class DocfyDemoDescription extends Component {
-}

package/components/docfy-demo/example.d.ts

@@ -1,3 +0,0 @@
-import Component from '@glimmer/component';
-export default class DocfyDemoExample extends Component {
-}

package/components/docfy-demo/snippet.d.ts

@@ -1,13 +0,0 @@
-import Component from '@glimmer/component';
-import { SnippetRegisterArgs } from './snippets';
-interface DocfyDemoSnippetArgs {
-    name: string;
-    active: string;
-    registerSnippet: (snippet: SnippetRegisterArgs) => void;
-}
-export default class DocfyDemoSnippet extends Component<DocfyDemoSnippetArgs> {
-    id: string;
-    constructor(owner: unknown, args: DocfyDemoSnippetArgs);
-    get isActive(): boolean;
-}
-export {};

package/components/docfy-demo/snippets.d.ts

@@ -1,11 +0,0 @@
-import Component from '@glimmer/component';
-export interface SnippetRegisterArgs {
-    id: string;
-    name: string;
-}
-export default class DocfyDemoSnippets extends Component {
-    snippets: SnippetRegisterArgs[];
-    active?: string;
-    registerSnippet(snippet: SnippetRegisterArgs): void;
-    setActiveSnippet(id: string): void;
-}

package/components/docfy-demo.d.ts

@@ -1,7 +0,0 @@
-import Component from '@glimmer/component';
-interface DocfyDemoArgs {
-    id: string;
-}
-export default class DocfyDemo extends Component<DocfyDemoArgs> {
-}
-export {};

package/components/docfy-link.d.ts

@@ -1,15 +0,0 @@
-import Component from '@glimmer/component';
-import RouterService from '@ember/routing/router-service';
-interface DocfyLinkArgs {
-    to: string;
-    anchor?: string;
-    activeClass?: string;
-}
-export default class DocfyLink extends Component<DocfyLinkArgs> {
-    router: RouterService;
-    get routeName(): string;
-    get href(): string;
-    get isActive(): boolean;
-    navigate(event: MouseEvent): void;
-}
-export {};

package/components/docfy-output.d.ts

@@ -1,16 +0,0 @@
-import Component from '@glimmer/component';
-import { NestedPageMetadata, PageMetadata } from '@docfy/core/lib/types';
-import RouterService from '@ember/routing/router-service';
-import DocfyService from '../services/docfy';
-interface DocfyOutputArgs {
-    type?: 'flat' | 'nested';
-    fromCurrentURL?: boolean;
-    url?: string;
-    scope?: string;
-}
-export default class DocfyOutput extends Component<DocfyOutputArgs> {
-    router: RouterService;
-    docfy: DocfyService;
-    get output(): NestedPageMetadata | PageMetadata[] | PageMetadata | undefined;
-}
-export {};

package/components/docfy-previous-and-next-page.d.ts

@@ -1,12 +0,0 @@
-import Component from '@glimmer/component';
-import DocfyService from '../services/docfy';
-import { PageMetadata } from '@docfy/core/lib/types';
-interface DocfyPreviousAndNextPageArgs {
-    scope?: string;
-}
-export default class DocfyPreviousAndNextPage extends Component<DocfyPreviousAndNextPageArgs> {
-    docfy: DocfyService;
-    get previous(): PageMetadata | undefined;
-    get next(): PageMetadata | undefined;
-}
-export {};

package/config/environment.js

@@ -1,5 +0,0 @@
-'use strict';
-
-module.exports = function (/* environment, appConfig */) {
-  return {};
-};

package/docs/components/docfy-demo.md

@@ -1,67 +0,0 @@
----
-order: 4
-category: components
-title: <DocfyDemo>
----
-
-# {{"<DocfyDemo>"}}
-
-This component is used internally to render demos. It's not meant to be used directly,
-although that's possible. The scope of what you want to understand is the CSS
-classes such that you can style the parts of the demo component yourself.
-
-Make sure to look at [writing demos](../writing-demos.md), so you can understand how demos look.
-
-Below is an example of how styling could look like. It uses
-[TailwindCSS](https://tailwindcss.com/) and [PostCSS Nested](https://github.com/postcss/postcss-nested).
-
-```css
-.docfy-demo__example {
-  @apply p-4 border rounded-t;
-}
-
-.docfy-demo__description {
-  @apply p-4 border-l border-r;
-
-  &__header {
-    @apply flex justify-between;
-
-    &__title {
-      @apply mb-4 font-medium leading-tight text-gray-900;
-    }
-
-    &__edit-url {
-      @apply text-sm;
-    }
-  }
-
-  &__content {
-    @apply markdown;
-  }
-}
-.docfy-demo__snippets {
-  &__tabs {
-    @apply px-2 border-l border-r;
-
-    &__button {
-      @apply p-2 mr-2 border-b-4;
-
-      &--active,
-      &:hover {
-        @apply border-blue-500;
-      }
-    }
-  }
-}
-
-.docfy-demo__snippet {
-  pre {
-    @apply p-4;
-    @apply flex text-gray-200 bg-gray-800;
-    @apply text-sm leading-normal;
-    @apply font-mono;
-    @apply rounded-b;
-    scrollbar-width: none;
-  }
-}
-```

package/docs/components/docfy-link-demo/anchor.md

@@ -1,9 +0,0 @@
-# Example with Anchor
-
-```hbs template
-<DocfyOutput @fromCurrentURL={{true}} as |page|>
-  <DocfyLink @to={{page.url}} @anchor="examples">
-    Link to a anchor
-  </DocfyLink>
-</DocfyOutput>
-```

package/docs/components/docfy-link-demo/simple.md

@@ -1,7 +0,0 @@
-# Simple Example
-
-```hbs template
-<DocfyLink @to="/docs">
-  Link to Docs
-</DocfyLink>
-```

package/docs/components/docfy-link.md

@@ -1,31 +0,0 @@
----
-order: 2
-category: components
-title: <DocfyLink>
----
-
-# {{"<DocfyLink>"}}
-
-This component is useful for linking to pages created by Docfy. It understands
-how the routing in Ember was designed and can correctly link to a given page URL.
-If the component is not able to figure out the correct Ember route, it will fall
-back to setting `windown.location` directly.
-
-DocfyLink can also link to an anchor; this allows for linking to specific sections
-on a page. Note that linking to an anchor may cause a full-page reload given that
-Ember doesn't have support for anchors.
-
-> Docfy also uses this component internally to replace any links between your
-> markdown files. It gives a pleasant User Experience because it can use the
-> Ember Routing to make the page transition, removing the need for a full-page reload.
-
-Below you can see a simple example of this component; however, you can see more
-of its usage throughout the documentation.
-
-# API
-
-| Argument       | Description                                     | Type                    | Default Value |
-| -------------- | ----------------------------------------------- | ----------------------- | ------------- |
-| `@to`          | The URL to link                                 | `string`                |               |
-| `@anchor`      | An anchor                                       | `string` \| `undefined` |               |
-| `@activeClass` | The classes to be added when the link is active | `string` \| `undefined` |               |

package/docs/components/docfy-output-demo/edit-page.md

@@ -1,54 +0,0 @@
----
-order: 3
----
-
-# Edit this page
-
-This is another example using `@fromCurrentURL`, but here we build a "edit this
-page" link.
-
-For this feature to work, Docfy must be able to find the repository URL. In
-Ember apps, we extract that from the `package.json`, but you can configure the
-repository URL as well as the branch to edit.
-
-```hbs template
-<DocfyOutput @fromCurrentURL={{true}} as |page|>
-  {{#if page.editUrl}}
-    <a href={{page.editUrl}}>
-      Click here to edit this page
-    </a>
-  {{/if}}
-</DocfyOutput>
-```
-
-For this to work, you need to include `repository` in your docfy-config:
-
-```js
-// in your docfy-config.js
-module.exports = {
-  repository: {
-    url: 'https://github.com/@username/repo-name',
-    editBranch: 'main',
-  },
-  ...// rest of your config
-}
-```
-
-
-## Enterprise (aka on premise) git services
-
-`page.editUrl` works for Github, Bitbucket, Gitlab and Sourcehut.
-
-For on-premise instances git solutions (i.e. on-premise Gitlab, or on-premise Bitbucket), we expose the `page.relativePath` so that you might construct your own custom editUrl:
-
-```hbs 
-<DocfyOutput @fromCurrentURL={{true}} as |page|>
-  {{#if page.relativePath}}
-    <a href=(concat "http://some-enterpise.com/browse/" page.relativePath)
-      Click here to edit this page
-    </a>
-  {{/if}}
-</DocfyOutput>
-```
-
-Note: the edit url for your on-premise instance might be more complex than the example above. But the `page.relativePath` will give you the relative path to that file in your repo. 

package/docs/components/docfy-output-demo/flat.md

@@ -1,23 +0,0 @@
----
-order: 5
----
-
-# Flat output
-
-This option will return an array of `PageMetadata`. It will contain all the
-pages in a flat array, one could render a list of all the pages without worrying
-about the scope.
-
-```hbs template
-<DocfyOutput @type="flat" as |pages|>
-  <ul class="list-disc list-inside space-y-2">
-    {{#each pages as |page|}}
-      <li>
-        <DocfyLink @to={{page.url}}>
-          {{page.title}}
-        </DocfyLink>
-     </li>
-    {{/each}}
-  </ul>
-</DocfyOutput>
-```

package/docs/components/docfy-output-demo/on-this-page.md

@@ -1,30 +0,0 @@
----
-order: 2
----
-
-# On this page
-
-In this example, we are using the option `@fromCurrentURL`. It tells the component
-to search for the definition of the page that corresponds to the current URL.
-We are then using the `headings` property, a data structure that represents a
-Table of Content. The `headings` is a recursive data structure, meaning that you
-can render their child for subheadings and their sub-subheadings. The depth of
-headings available here is default to 6 but can be changed using the configuration
-option `tocMaxDepth`.
-
-```hbs template
-<DocfyOutput @fromCurrentURL={{true}} as |page|>
-  <div class="mb-4 font-medium">
-    On this page:
-  </div>
-  <ul class="list-disc list-inside space-y-2">
-    {{#each page.headings as |heading|}}
-      <li>
-        <a href="#{{heading.id}}">
-          {{heading.title}}
-        </a>
-      </li>
-    {{/each}}
-  </ul>
-</DocfyOutput>
-```

package/docs/components/docfy-output-demo/sidebar.md

@@ -1,45 +0,0 @@
----
-order: 1
----
-
-# Sidebar Navigation
-
-In this example, we are filtering the `NestedPageMetadata` by the scope name `docs`.
-Then we use the yielded data to render pages, their children, and their children's
-pages. Depending on how your documentation is structured, you might need to render
-more deep into the tree or more shadow.
-
-> You might have noticed that for this documentation site, we haven't rendered
-> too deep into the tree to display all items.
-
-```hbs template
-<DocfyOutput @scope="docs" as |node|>
-  <ul class="list-disc list-inside space-y-2">
-    {{#each node.pages as |page|}}
-      <li>
-        <DocfyLink @to={{page.url}}>
-          {{page.title}}
-        </DocfyLink>
-      </li>
-    {{/each}}
-
-    {{#each node.children as |child|}}
-      <li class="block ml-4">
-        <div class="py-2">
-          {{child.label}}
-        </div>
-
-        <ul class="list-disc list-inside space-y-2">
-          {{#each child.pages as |page|}}
-            <li>
-              <DocfyLink @to={{page.url}}>
-                {{page.title}}
-              </DocfyLink>
-            </li>
-          {{/each}}
-        </ul>
-      </li>
-    {{/each}}
-  </ul>
-</DocfyOutput>
-```

package/docs/components/docfy-output-demo/top-nav.md

@@ -1,35 +0,0 @@
----
-order: 4
----
-
-# Top Navigation
-
-Here is another example that builds a top nav that could be used for the entire
-application. It will link to any top-level pages as well as to the first page of
-every child.
-
-```hbs template
-<DocfyOutput @type="nested" as |node|>
-  <ul>
-    {{#each node.pages as |page|}}
-      <li>
-        <DocfyLink @to={{page.url}}>
-          {{page.title}}
-        </DocfyLink>
-     </li>
-    {{/each}}
-
-    {{#each node.children as |child|}}
-      {{#let (get child.pages 0) as |page|}}
-        {{#if page}}
-          <li>
-            <DocfyLink @to={{page.url}}>
-              {{child.label}}
-            </DocfyLink>
-          </li>
-        {{/if}}
-      {{/let}}
-    {{/each}}
-  </ul>
-</DocfyOutput>
-```