Skip to content

miguelgargallo/Pen

Repository files navigation

pen

What is pen?

The .pen file is a variation of the traditional markdown file format that is used for formatting text and creating documents in the Pylar programming language. The .pen file adds additional syntax for defining actions and importing libraries in the Pylar language, including keywords such as 'say', 'ifis', and 'also'. These keywords are used to perform specific tasks or operations in the Pylar language, such as printing output to the console, specifying a condition in an if statement, or defining a variable.

Modularity

In the .pen file format, users have the ability to customize how they want to mark the sections of their document. By adding ".pen" to the root of their .pen file, users can specify their own unique syntax for headings, paragraphs, and other text elements.

For example, instead of using the default numbering system for headings, such as "#1 Title" or "#2 Subtitle", users can specify their own syntax using words, symbols, or other characters. For instance, a heading might be formatted as "#A Title" or "#🚩 Subtitle".

This customization feature allows users to tailor the .pen file to their specific needs and preferences, and can make it easier to navigate and organize their document. It is also possible to change the default syntax for other elements such as paragraphs, lists, and code blocks, by simply specifying a new syntax in the .pen file.

Overall, the .pen file format provides users with the flexibility to customize the formatting and organization of their document in a way that best suits their needs.

How do I use pen?

One difference between the .pen file and the traditional markdown (.md) file is that the .pen file includes a numbering system for headings, paragraphs, and other text elements. For example, a heading might be formatted as "#1 Title" or "#2 Subtitle", with the number indicating the level of the heading. This numbering system allows for easier organization and navigation within the .pen document.

md Vs pen

Another difference is that the .pen file includes additional formatting options for paragraphs and lists, such as the ability to specify bullet points or numbered lists. These formatting options can be specified by using specific keywords, such as 'bullet' or 'number', followed by the text to be formatted.

The .pen file format combines the formatting capabilities of traditional markdown with the ability to define actions and import libraries in the Pylar programming language, as well as unique formatting options for headings, paragraphs, and lists.

Feature Comparison

| Feature                   | .pen File       | .md File        |
|---------------------------|-----------------|-----------------|
| Syntax for defining actions and importing libraries | Yes | No |
| Numbering system for headings, paragraphs, and other text elements | Yes | No |
| Additional formatting options for paragraphs and lists | Yes | No |
| Basic formatting capabilities (headings, lists, links) | Yes | Yes |
| Syntax highlighting for code blocks | Yes | Yes |
| Table formatting | Yes | Yes |
| Image embedding | Yes | Yes |
| Anchor links | Yes | Yes |
| Blockquotes | Yes | Yes |
| Definition lists | Yes | Yes |
| Task lists | Yes | Yes |
| Abbreviations | Yes | Yes |
| Footnotes | Yes | Yes |
| Custom containers | Yes | Yes |
| Emoji support | Yes | Yes |
| Definition of terms | Yes | Yes |
| Definition of abbreviations | Yes | Yes |
| Definition of acronyms | Yes | Yes |
| Definition of symbols | Yes | Yes |
| Definition of variables | Yes | Yes |
| Definition of functions | Yes | Yes |
| Definition of classes | Yes | Yes |
| Definition of methods | Yes | Yes |
| Definition of properties | Yes | Yes |
| Definition of attributes | Yes | Yes |

12 Things that pen can do that .md can't

  • Syntax for defining actions and importing libraries in the Pylar programming language
  • Numbering system for headings, paragraphs, and other text elements for easier organization and navigation.
  • Additional formatting options for paragraphs and lists, such as bullet points or numbered lists
  • Syntax highlighting for Pylar code blocks
  • Custom containers for grouping and formatting content
  • Definition of terms, abbreviations, acronyms, symbols, variables, functions, classes, methods, properties, and attributes in the Pylar language
  • Emoji support for adding emoticons to text
  • Anchor links for creating hyperlinks that jump to specific sections within the document
  • Blockquotes with custom styling options
  • Definition lists with custom formatting options
  • Task lists with checkbox options
  • Abbreviations with custom definitions and styling options

Releases

No releases published

Sponsor this project

Packages

No packages published