Skip to content

Commit

Permalink
Add doc for Nammatham v1 (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
mildronize authored May 8, 2024
2 parents e124aca + 26b64ca commit 0d2bd3e
Show file tree
Hide file tree
Showing 30 changed files with 881 additions and 640 deletions.
12 changes: 0 additions & 12 deletions apps/nammatham/blog/2019-05-28-first-blog-post.md

This file was deleted.

45 changes: 5 additions & 40 deletions apps/nammatham/blog/2019-05-29-long-blog-post.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,9 @@
---
slug: long-blog-post
title: Long Blog Post
authors: endi
tags: [hello, docusaurus]
slug: release-nammatham-doc-site
title: Release Nammatham Doc Site
authors: thada
tags: [doc]
---

This is the summary of a very long blog post,
Hooraay! We are ready to release the Nammatham Doc Site.

Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.

<!--truncate-->

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
20 changes: 0 additions & 20 deletions apps/nammatham/blog/2021-08-01-mdx-blog-post.mdx

This file was deleted.

Binary file not shown.
25 changes: 0 additions & 25 deletions apps/nammatham/blog/2021-08-26-welcome/index.md

This file was deleted.

22 changes: 5 additions & 17 deletions apps/nammatham/blog/authors.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
endi:
name: Endilie Yacop Sucipto
title: Maintainer of Docusaurus
url: https://github.com/endiliey
image_url: https://github.com/endiliey.png

yangshun:
name: Yangshun Tay
title: Front End Engineer @ Facebook
url: https://github.com/yangshun
image_url: https://github.com/yangshun.png

slorber:
name: Sébastien Lorber
title: Docusaurus maintainer
url: https://sebastienlorber.com
image_url: https://github.com/slorber.png
thada:
name: Thada Wangthammang
title: Nammatham Creator
url: https://github.com/mildronize
image_url: https://avatars.githubusercontent.com/u/3647850?v=4
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Tutorial - Extras",
"label": "Community",
"position": 3,
"link": {
"type": "generated-index"
Expand Down
19 changes: 19 additions & 0 deletions apps/nammatham/docs/community/local-dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
sidebar_position: 1
---

# Local Development

```sh
npx nx build nammatham
# or
npx nx run nammatham:build
npx nx run nammatham:dev

npx nx run nammatham:test:watch


# Publish npm with nx
pnpm --filter nammatham publish
```

8 changes: 8 additions & 0 deletions apps/nammatham/docs/concept/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Concepts",
"position": 2,
"link": {
"type": "generated-index",
"description": "Nammatham Concepts."
}
}
130 changes: 130 additions & 0 deletions apps/nammatham/docs/concept/binding-type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
---
sidebar_position: 3
---
# All Built-in Binding Type

You can see all built-in binding type in [test case](packages/core/src/test-usecases/all-bindings/fixtures/functions/all-bindings.function.ts) as shown below:

```ts
import { BaseFunction, binding, functionName } from '../../../../main';
import { responseHelper } from '../../../response-helper';
import { HttpRequest, HttpResponse, Timer } from '@azure/functions';

const bindings = [
binding.httpTrigger({ name: 'req' as const }), // make string to literal type
binding.http({ name: 'res' as const }), // make string to literal type
binding.http_withReturn(),
binding.timerTrigger({ name: 'timer' as const, schedule: '*' }), // make string to literal type
binding.cosmosDBTrigger_v2({
name: 'document_trigger_v2' as const,
collectionName: '',
connectionStringSetting: '',
databaseName: '',
}),
binding.cosmosDBTrigger_v4({
name: 'document_trigger_v4' as const,
connection: '',
containerName: '',
databaseName: '',
}),
binding.cosmosDBTrigger({
name: 'document_trigger_default' as const,
connection: '',
containerName: '',
databaseName: '',
}),
binding.cosmosDB_output_v2({
name: 'document_output_v2' as const,
collectionName: '',
connectionStringSetting: '',
createIfNotExists: true,
databaseName: '',
}),
binding.cosmosDB_output_v4({
name: 'document_output_v4' as const,
createIfNotExists: true,
databaseName: '',
connection: '',
containerName: '',
}),
binding.cosmosDB_output({
name: 'document_output_default' as const,
createIfNotExists: true,
databaseName: '',
connection: '',
containerName: '',
}),
binding.cosmosDB_input_v2({
name: 'document_input_v2' as const,
collectionName: '',
connectionStringSetting: '',
databaseName: '',
id: '',
partitionKey: '',
sqlQuery: '',
}),
binding.cosmosDB_input_v4({
name: 'document_input_v4' as const,
databaseName: '',
id: '',
partitionKey: '',
sqlQuery: '',
connection: '',
containerName: '',
}),
binding.cosmosDB_input({
name: 'document_input_default' as const,
databaseName: '',
id: '',
partitionKey: '',
sqlQuery: '',
connection: '',
containerName: '',
}),
binding.blobTrigger({
connection: '',
name: 'blob_trigger' as const,
path: '',
}),
binding.blob_input({
connection: '',
name: 'blob_input' as const,
path: '',
}),
binding.blob_output({
connection: '',
name: 'blob_output' as const,
path: '',
}),
] as const;

const customBindings = binding.custom({ name: 'req' as const, type: 'custom', direction: 'in' });

@functionName('AllBindingsFunction', ...bindings, customBindings)
export class AllBindingsFunction extends BaseFunction<typeof bindings> {
public override execute() {
const req: HttpRequest = this.bindings.req;
const res: HttpResponse = this.bindings.res;
const timer: Timer = this.bindings.timer;

const document_output_v2: any = this.bindings.document_output_v2;
const document_output_v4: any = this.bindings.document_output_v4;
const document_output_default: any = this.bindings.document_output_default;

const document_input_v2: any = this.bindings.document_input_v2;
const document_input_v4: any = this.bindings.document_input_v4;
const document_input_default: any = this.bindings.document_input_default;

const document_trigger_v2: any = this.bindings.document_trigger_v2;
const document_trigger_v4: any = this.bindings.document_trigger_v4;
const document_trigger_default: any = this.bindings.document_trigger_default;

const blob_trigger: any = this.bindings.blob_trigger;
const blob_input: any = this.bindings.blob_input;
const blob_output: any = this.bindings.blob_output;

const { name } = this.req.query;
this.res.send(responseHelper(name));
}
}
```
Loading

0 comments on commit 0d2bd3e

Please sign in to comment.