You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -87,7 +87,7 @@ After completing the installation steps above, you can immediately test the syst
87
87
### Documentation
88
88
89
89
- For more details on the ***plain format, see the [***plain language specification](docs/plain_language_specification.md).
90
-
- For step-by-step instructions for creating your first ***plain project see the [Kickstart your plain project](docs/starting_a_plain_project_from_scratch.md).
90
+
- For step-by-step instructions for creating your first ***plain project see the [Kickstart your ***plain project](docs/starting_a_plain_project_from_scratch.md).
91
91
- For complete CLI documentation and usage examples, see [plain2code CLI documentation](docs/plain2code_cli.md).
Copy file name to clipboardExpand all lines: docs/plain_language_specification.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -115,7 +115,7 @@ Definitions are the mechanism for definining data structures in ***plain. Here's
115
115
116
116
The `***Non-Functional Requirements:***` specification is a list of instructions that steer software code implementation and provide details of execution environment.
117
117
118
-
Here's an example of a simple instruction specifying only that the Plain specification should be rendered to Python software code.
118
+
Here's an example of a simple instruction specifying only that the ***plain specification should be rendered to Python software code.
119
119
120
120
```plain
121
121
- :Implementation: should be in Python.
@@ -149,7 +149,7 @@ Each functional requirement must be limited in complexity. For example, for the
149
149
- :App: should implement a task manager application.
150
150
```
151
151
152
-
the renderer of Plain source to software code should respond with
152
+
the renderer of ***plain source to software code should respond with
153
153
154
154
```
155
155
Functional requirement too complex!
@@ -219,18 +219,18 @@ Lines starting with `>` are ignored when rendering software code.
219
219
220
220
## Template System
221
221
222
-
Plain supports template inclusion using the `{% include %}` syntax, which allows you to use predefined templates in your specifications.
222
+
***plain supports template inclusion using the `{% include %}` syntax, which allows you to use predefined templates in your specifications.
223
223
224
224
```plain
225
225
{% include "python-console-app-template.plain", main_executable_file_name: "my_app.py" %}
226
226
```
227
227
Predefined templates are available for Go console apps, Python console apps, and TypeScript React apps in the [standard template library](../standard_template_library/). You can also create your own custom templates.
228
228
229
-
The template system enables code reuse and standardization across Plain projects.
229
+
The template system enables code reuse and standardization across ***plain projects.
230
230
231
231
## Linked Resources
232
232
233
-
If you include a link using the markdown syntax, the linked resource will be passed along with the Plain specification to the renderer.
233
+
If you include a link using the markdown syntax, the linked resource will be passed along with the ***plain specification to the renderer.
234
234
235
235
Here's an example of a linked resource (see Task manager example application for the full specification).
236
236
@@ -239,12 +239,12 @@ Here's an example of a linked resource (see Task manager example application for
239
239
```
240
240
241
241
**Important Notes:**
242
-
- Only links to files in the same folder (and its subfolders) as the Plain specification are supported. Links to external resources are not supported.
243
-
- File paths are resolved relative to the location of the Plain specification file.
242
+
- Only links to files in the same folder (and its subfolders) as the ***plain specification are supported. Links to external resources are not supported.
243
+
- File paths are resolved relative to the location of the ***plain specification file.
244
244
- All types are supported, except binary files.
245
245
246
246
## Liquid templates
247
247
248
-
Plain supports Liquid templates. Liquid is an open-source template language created by Shopify (https://shopify.github.io/liquid/).
248
+
***plain supports Liquid templates. Liquid is an open-source template language created by Shopify (https://shopify.github.io/liquid/).
249
249
250
250
For a sample use of Liquid templates see [example-saas-connectors](https://github.com/Codeplain-ai/example-saas-connectors) repository.
Copy file name to clipboardExpand all lines: docs/starting_a_plain_project_from_scratch.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# How to Start a New Plain Project from Scratch
1
+
# How to Start a New ***plain Project from Scratch
2
2
3
-
This guide will walk you through creating your first Plain project from scratch.
3
+
This guide will walk you through creating your first ***plain project from scratch.
4
4
It assumes you have already:
5
5
6
6
✅ Met all [prerequisites](../README.md#prerequisites),
@@ -9,11 +9,11 @@ It assumes you have already:
9
9
10
10
If you haven't done so yet, please refer to [README](../README.md).
11
11
12
-
After following this guide, you'll be equipped to turn your ideas into working code with Plain.
12
+
After following this guide, you'll be equipped to turn your ideas into working code with ***plain.
13
13
14
14
## Project Structure Overview
15
15
16
-
Every Plain project follows this basic structure:
16
+
Every ***plain project follows this basic structure:
17
17
18
18
```
19
19
my-new-project/
@@ -29,7 +29,7 @@ In this guide we will cover how to create each of these step by step.
29
29
30
30
## 1. Define Your .plain File
31
31
32
-
Create a `.plain` file. The following example shows how to specify the array sorting problem. For more details, see [Plain language specifications](plain_language_specification.md).
32
+
Create a `.plain` file. The following example shows how to specify the array sorting problem. For more details, see [***plain language specifications](plain_language_specification.md).
0 commit comments