Skip to content

Commit

Permalink
docs: update to new links
Browse files Browse the repository at this point in the history
  • Loading branch information
imranbarbhuiya committed Apr 16, 2023
1 parent de9fd57 commit 7f0f5ed
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 14 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ const result = await ts.run(
); // Parbez attempts to pick the lock!, I pick heads
```

For more usage, check out the full [documentation](https://tagscript.js.org/modules/tagscript.html).
For more usage, check out the documentation [here](https://tagscript.js.org/).

## Buy me some doughnuts

Expand Down
21 changes: 21 additions & 0 deletions apps/website/src/pages/plugins.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import Image from 'next/image';

import Logo from '../../../../.github/logo_short.png';

<div className="flex justify-center items-center flex-col">

<Image src={Logo} alt="TagScript Logo" width={250} height={250} placeholder="blur" />

# TagScript Plugins

</div>

Tagscript supports plugins to better customize your experience. You can create your own plugins or use the ones that are already available.

## Built-in Plugins

- [Plugin Discord](./plugin-discord.md) - Provides Discord.js related parsers and transformers.

## Creating Plugins

A guide will be added in future. For now you can check source code of [plugin-discord](https://github.com/imranbarbhuiya/TagScript/tree/main/packages/tagscript-plugin-discord) for an example.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import Image from 'next/image';

import Logo from '../../../../../.github/logo_short.png';
import Logo from '../../../../.github/logo_short.png';

<div className="flex justify-center items-center flex-col">

Expand Down
7 changes: 1 addition & 6 deletions apps/website/theme.config.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import Link from 'next/link';
import { useRouter } from 'next/router';
import { useConfig, type DocsThemeConfig } from 'nextra-theme-docs';
import React from 'react';
Expand All @@ -13,11 +12,7 @@ const Vercel = ({ height = 20 }) => (
);

const config: DocsThemeConfig = {
logo: (
<Link className="flex justify-center items-center" href="https://tagscript.js.org">
Tagscript Documentation
</Link>
),
logo: 'Tagscript Documentation',
project: {
link: 'https://github.com/imranbarbhuiya/tagscript'
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { BaseParser, type Context, type IParser } from 'tagscript';
/**
* Delete the triggered message.
*
* @see Devs need to check for this property in [Response.actions](https://tagscript.js.org/classes/tagscript.Response.html#actions) and if true, delete the message.
* @see Devs need to check for this property in [Response.actions](https://tagscript.js.org/typedoc-api/tagscript/classes/Response#actions) and if true, delete the message.
*/
export class DeleteParser extends BaseParser implements IParser {
public constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { BaseParser, type Context, type IParser } from 'tagscript';
/**
* Silence the used command outputs.
*
* @see Devs need to check for this property in [Response.actions](https://tagscript.js.org/classes/tagscript.Response.html#actions) and if true, don't output of the command used.
* @see Devs need to check for this property in [Response.actions](https://tagscript.js.org/typedoc-api/tagscript/classes/Response#actions) and if true, don't output of the command used.
*/
export class SilentParser extends BaseParser implements IParser {
public constructor() {
Expand Down
8 changes: 4 additions & 4 deletions packages/tagscript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@ const result = await ts.run(

## Parsers

Parsers are used to parse a tag and return a value based on the tag. You can use our [builtin parsers](https://github.com/imranbarbhuiya/TagScript/tree/main/src/lib/Parsers) or write your own parsers.
Your own parser should implement [IParser](https://tagscript.js.org/interfaces/IParser.html) interface.
Parsers are used to parse a tag and return a value based on the tag. You can use our [builtin parsers](https://tagscript.js.org/typedoc-api/tagscript/interfaces/IParser#implemented-by) or write your own parsers.
Your own parser should implement [IParser](https://tagscript.js.org/typedoc-api/tagscript/interfaces/IParser) interface.

```ts copy showLineNumbers
import { Interpreter, RandomParser, RangeParser, FiftyFiftyParser, IfStatementParser, SliceParser } from 'tagscript';
Expand All @@ -80,8 +80,8 @@ const ts = new Interpreter(new SliceParser(), new FiftyFiftyParser(), new Random

## Transformers

Transformers are used to transform a value based on the tag at runtime. You can use our [builtin transformers](https://github.com/imranbarbhuiya/TagScript/tree/main/src/lib/Transformer) or write your own transformers.
Your own transformer should implement [ITransformer](https://tagscript.js.org/interfaces/ITransformer.html) interface.
Transformers are used to transform a value based on the tag at runtime. You can use our [builtin transformers](https://tagscript.js.org/typedoc-api/tagscript/interfaces/ITransformer#implimented-by) or write your own transformers.
Your own transformer should implement [ITransformer](https://tagscript.js.org/typedoc-api/tagscript/interfaces/ITransformer) interface.

```ts copy showLineNumbers
import { Interpreter, StringTransformer, StrictVarsParser } from 'tagscript';
Expand Down

1 comment on commit 7f0f5ed

@vercel
Copy link

@vercel vercel bot commented on 7f0f5ed Apr 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.