Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit bbd8410

Browse files
committed
rename file: to title:
1 parent 7abf39c commit bbd8410

File tree

20 files changed

+103
-103
lines changed

20 files changed

+103
-103
lines changed

docs/apis.mdx

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -714,7 +714,7 @@ By default APIs deployed by Nitric will be assigned a domain by the target cloud
714714

715715
<TabItem label="AWS">
716716

717-
```yaml file:nitric.prod.yaml
717+
```yaml title:nitric.prod.yaml
718718
provider: nitric/[email protected]
719719
region: ap-southeast-2
720720

@@ -731,15 +731,15 @@ apis:
731731
732732
<TabItem label="Azure">
733733
734-
```yaml file:nitric.prod.yaml
734+
```yaml title:nitric.prod.yaml
735735
# currently unsupported - request support here: https://github.com/nitrictech/nitric/issues
736736
```
737737

738738
</TabItem>
739739

740740
<TabItem label="Google Cloud">
741741

742-
```yaml file:nitric.prod.yaml
742+
```yaml title:nitric.prod.yaml
743743
# currently unsupported - request support here: https://github.com/nitrictech/nitric/issues
744744
```
745745

@@ -755,7 +755,7 @@ By default, APIs will not be deployed with a description. You can add a descript
755755

756756
<TabItem label="AWS">
757757

758-
```yaml file:nitric.prod.yaml
758+
```yaml title:nitric.prod.yaml
759759
provider: nitric/[email protected]
760760
region: ap-southeast-2
761761

@@ -771,7 +771,7 @@ apis:
771771
772772
<TabItem label="Azure">
773773
774-
```yaml file:nitric.prod.yaml
774+
```yaml title:nitric.prod.yaml
775775
provider: nitric/[email protected]
776776
region: Australia East
777777
org: example-org
@@ -788,7 +788,7 @@ apis:
788788
789789
<TabItem label="Google Cloud">
790790
791-
```yaml file:nitric.prod.yaml
791+
```yaml title:nitric.prod.yaml
792792
provider: nitric/[email protected]
793793
region: australia-southeast1
794794

@@ -857,7 +857,7 @@ Since resource names are unique across each Nitric project, you can access a res
857857

858858
<CodeSwitcher>
859859

860-
```javascript !! file:services/one.js
860+
```javascript !! title:services/one.js
861861
import { api } from '@nitric/sdk'
862862
863863
const accountsApi = api('accounts')
@@ -867,7 +867,7 @@ accountsApi.get('/users/:id', async () => {
867867
})
868868
```
869869

870-
```python !! file:services/one.py
870+
```python !! title:services/one.py
871871
from nitric.application import Nitric
872872
from nitric.context import HttpContext
873873
from nitric.resources import api
@@ -881,7 +881,7 @@ async def get_user(ctx: HttpContext):
881881
Nitric.run()
882882
```
883883

884-
```go !! file:services/one/main.go
884+
```go !! title:services/one/main.go
885885
import (
886886
"github.com/nitrictech/go-sdk/nitric"
887887
"github.com/nitrictech/go-sdk/nitric/apis"
@@ -898,7 +898,7 @@ func main() {
898898
}
899899
```
900900

901-
```dart !! file:services/one.dart
901+
```dart !! title:services/one.dart
902902
import 'package:nitric_sdk/nitric.dart';
903903
904904
final accountsApi = Nitric.api("accounts");
@@ -912,7 +912,7 @@ galaxyApi.get("/users/:id", (ctx) async {
912912

913913
<CodeSwitcher>
914914

915-
```javascript !! file:services/two.js
915+
```javascript !! title:services/two.js
916916
import { api } from '@nitric/sdk'
917917
918918
const accountsApi = api('accounts')
@@ -922,7 +922,7 @@ accountsApi.get('/orgs/:id', async () => {
922922
})
923923
```
924924

925-
```python !! file:services/two.py
925+
```python !! title:services/two.py
926926
from nitric.application import Nitric
927927
from nitric.context import HttpContext
928928
from nitric.resources import api
@@ -936,7 +936,7 @@ async def get_org(ctx: HttpContext):
936936
Nitric.run()
937937
```
938938

939-
```go !! file:services/two/main.go
939+
```go !! title:services/two/main.go
940940
import (
941941
"github.com/nitrictech/go-sdk/nitric"
942942
"github.com/nitrictech/go-sdk/nitric/apis"
@@ -953,7 +953,7 @@ func main() {
953953
}
954954
```
955955

956-
```dart !! file:services/two.dart
956+
```dart !! title:services/two.dart
957957
import 'package:nitric_sdk/nitric.dart';
958958
959959
final accountsApi = Nitric.api("accounts");
@@ -978,19 +978,19 @@ Here is the same example enhanced to import a common API resource.
978978

979979
<CodeSwitcher>
980980

981-
```javascript !! file:resources/index.js
981+
```javascript !! title:resources/index.js
982982
import { api } from '@nitric/sdk'
983983
984984
export const accountsApi = api('accounts')
985985
```
986986

987-
```python !! file:common/resources.py
987+
```python !! title:common/resources.py
988988
from nitric.resources import api
989989
990990
accounts_api = api('accounts')
991991
```
992992

993-
```go !! file:resources/main.go
993+
```go !! title:resources/main.go
994994
import (
995995
"github.com/nitrictech/go-sdk/nitric"
996996
"github.com/nitrictech/go-sdk/nitric/apis"
@@ -1004,7 +1004,7 @@ func init() {
10041004
}
10051005
```
10061006

1007-
```dart !! file:common/resources.dart
1007+
```dart !! title:common/resources.dart
10081008
import 'package:nitric_sdk/nitric.dart';
10091009
10101010
final accountsApi = Nitric.api("accounts");
@@ -1014,15 +1014,15 @@ final accountsApi = Nitric.api("accounts");
10141014

10151015
<CodeSwitcher>
10161016

1017-
```javascript !! file:services/one.js
1017+
```javascript !! title:services/one.js
10181018
import { accountsApi } from '../resources'
10191019
10201020
accountsApi.get('/users/:id', async () => {
10211021
// your logic here
10221022
})
10231023
```
10241024

1025-
```python !! file:services/one.py
1025+
```python !! title:services/one.py
10261026
from nitric.application import Nitric
10271027
from nitric.context import HttpContext
10281028
from common.resources import accounts_api
@@ -1035,7 +1035,7 @@ async def get_user(ctx: HttpContext):
10351035
Nitric.run()
10361036
```
10371037

1038-
```go !! file:services/one/main.go
1038+
```go !! title:services/one/main.go
10391039
package main
10401040
10411041
import (
@@ -1054,7 +1054,7 @@ func main() {
10541054
}
10551055
```
10561056

1057-
```dart !! file:services/one.dart
1057+
```dart !! title:services/one.dart
10581058
import '../resources';
10591059
10601060
accountsApi.get("/users/:id", (ctx) async {
@@ -1066,15 +1066,15 @@ accountsApi.get("/users/:id", (ctx) async {
10661066

10671067
<CodeSwitcher>
10681068

1069-
```javascript !! file:services/two.js
1069+
```javascript !! title:services/two.js
10701070
import { accountsApi } from '../resources'
10711071
10721072
accountsApi.get('/orgs/:id', async () => {
10731073
// your logic here
10741074
})
10751075
```
10761076

1077-
```python !! file:services/two.py
1077+
```python !! title:services/two.py
10781078
from nitric.application import Nitric
10791079
from nitric.context import HttpContext
10801080
from common.resources import accounts_api
@@ -1087,7 +1087,7 @@ async def get_org(ctx: HttpContext):
10871087
Nitric.run()
10881088
```
10891089

1090-
```go !! file:services/two/main.go
1090+
```go !! title:services/two/main.go
10911091
package main
10921092
10931093
import (
@@ -1106,7 +1106,7 @@ func main() {
11061106
}
11071107
```
11081108

1109-
```dart !! file:services/two.dart
1109+
```dart !! title:services/two.dart
11101110
import '../resources';
11111111
11121112
accountsApi.get("/orgs/:id", (ctx) async {

docs/further-reading/comparison/ampt.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To get a deeper understanding of the differences, let's see the same app built i
2323

2424
**Nitric**
2525

26-
```typescript file:hello.ts
26+
```typescript title:hello.ts
2727
import { api } from '@nitric/sdk'
2828

2929
const helloApi = api('main')
@@ -41,7 +41,7 @@ helloApi.get('/hello/:name', async (ctx) => {
4141

4242
**Ampt (Experimental)**
4343

44-
```typescript file:hello.ts
44+
```typescript title:hello.ts
4545
import { api } from '@ampt/api'
4646

4747
const helloApi = api('main').router('/hello')

docs/further-reading/comparison/aws-cdk.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To get a deeper understanding of the differences, let's see the same app built i
2424

2525
**Nitric**
2626

27-
```typescript file:hello.ts
27+
```typescript title:hello.ts
2828
import { api } from '@nitric/sdk'
2929

3030
const helloApi = api('main')
@@ -42,7 +42,7 @@ helloApi.get('/hello/:name', async (ctx) => {
4242

4343
**AWS CDK**
4444

45-
```javascript file:src/index.js
45+
```javascript title:src/index.js
4646
exports.handler = async function (event = {}) {
4747
const name = event.pathParameters.name
4848

@@ -53,7 +53,7 @@ exports.handler = async function (event = {}) {
5353
}
5454
```
5555

56-
```typescript file:lib/hello-stack.ts
56+
```typescript title:lib/hello-stack.ts
5757
import * as cdk from 'aws-cdk-lib'
5858
import { Construct } from 'constructs'
5959
import * as apigateway from 'aws-cdk-lib/aws-apigateway'

docs/further-reading/comparison/encore.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To get a deeper understanding of the differences, let's see the same app built i
2323

2424
**Nitric**
2525

26-
```go file:services/hello/main.go
26+
```go title:services/hello/main.go
2727
package main
2828

2929
import (
@@ -50,7 +50,7 @@ func main() {
5050

5151
**Encore**
5252

53-
```go file:hello.go
53+
```go title:hello.go
5454
package hello
5555

5656
import (

docs/further-reading/comparison/pulumi.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To showcase the power of the abstraction provided by Nitric here is a showcase o
3434

3535
**Nitric**
3636

37-
```javascript file:handle.js
37+
```javascript title:handle.js
3838
import * as nitric from '@nitric/sdk'
3939

4040
const bucket = nitric.bucket('my-bucket').allow('read', 'write')
@@ -50,7 +50,7 @@ bucket.on('create', '*', async (ctx) => {
5050

5151
**Pulumi**
5252

53-
```javascript file:src/index.js
53+
```javascript title:src/index.js
5454
const AWS = require('aws-sdk')
5555

5656
exports.handler = async (event) => {
@@ -61,7 +61,7 @@ exports.handler = async (event) => {
6161
}
6262
```
6363

64-
```javascript file:lib/handle-stack.js
64+
```javascript title:lib/handle-stack.js
6565
import * as pulumi from '@pulumi/pulumi'
6666
import * as aws from '@pulumi/aws'
6767
import * as fs from 'fs'

docs/further-reading/comparison/sst.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To get a deeper understanding of the differences, let's see the same app built i
2424

2525
**Nitric**
2626

27-
```javascript file:hello.js
27+
```javascript title:hello.js
2828
import { api } from '@nitric/sdk'
2929

3030
const helloApi = api('main')
@@ -42,7 +42,7 @@ helloApi.get('/hello/:name', async (ctx) => {
4242

4343
**SST**
4444

45-
```javascript file:packages/functions/hello.ts
45+
```javascript title:packages/functions/hello.ts
4646
import { ApiHandler, usePathParam } from 'sst/node/api'
4747

4848
export const handler = ApiHandler(async (evt) => {
@@ -55,7 +55,7 @@ export const handler = ApiHandler(async (evt) => {
5555
})
5656
```
5757

58-
```javascript file: stacks/hello-stack.ts
58+
```javascript title: stacks/hello-stack.ts
5959
import { StackContext, Api } from 'sst/constructs'
6060

6161
export function API({ stack }: StackContext) {

docs/further-reading/comparison/terraform.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ To showcase the power of the abstraction provided by Nitric here is a showcase o
3232

3333
**Nitric**
3434

35-
```javascript file:handle.js
35+
```javascript title:handle.js
3636
import * as nitric from '@nitric/sdk'
3737

3838
const bucket = nitric.bucket('my-bucket').allow('read', 'write')
@@ -48,7 +48,7 @@ bucket.on('create', '*', async (ctx) => {
4848

4949
**Terraform**
5050

51-
```javascript file:src/index.js
51+
```javascript title:src/index.js
5252
const AWS = require('aws-sdk')
5353

5454
exports.handler = async (event) => {
@@ -59,7 +59,7 @@ exports.handler = async (event) => {
5959
}
6060
```
6161

62-
```hcl file:main.tf
62+
```hcl title:main.tf
6363
terraform {
6464
required_providers {
6565
aws = {

docs/further-reading/comparison/winglang.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Both options are extremely productive, it's up to you which approach you prefer.
2020

2121
**Nitric**
2222

23-
```javascript file:hello.js
23+
```javascript title:hello.js
2424
import { api } from '@nitric/sdk'
2525

2626
const helloApi = api('far-away-galaxy-api')

0 commit comments

Comments
 (0)