Merge pull request #4 from miaowware:rel

Release prep 1.0.0

CHANGELOG.md

@@ -8,9 +8,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 
-<!-- ## [{{version}}] - YYYY-MM-DD -->
+## [1.0.0] - 2021-09-07
+### Added
+- Inline markdown formatting.
+- Blockquote formatting.
+- Code block formatting.
+- URL formatting (Titled and Non-embedding).
+- User/Role/Channel mention formatting.
+- Timestamp formatting.
+- Markdown and mention escaping functions.
 
 
-<!-- NOTE: Add these links to link the title of each section of the changelog to link to the release -->
-<!-- [Unreleased]: https://github.com/miaowware/discord-styled-text/compare/{{version}}...HEAD -->
-<!-- [{{version}}]: https://github.com/miaowware/discord-styled-text/releases/tag/{{version}} -->
+[Unreleased]: https://github.com/miaowware/discord-styled-text/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/miaowware/discord-styled-text/releases/tag/v1.0.0

discord_styler/__info__.py

@@ -6,7 +6,7 @@
 __summary__ = "A small library to style text for Discord without having to remember any syntax"
 __webpage__ = "https://discord-styled-text.miaow.io"
 
-__version__ = "{{version}}"
+__version__ = "1.0.0"
 
 __author__ = "classabbyamp, 0x5c"
 __email__ = "[email protected], [email protected]"

discord_styler/styler.py

@@ -11,9 +11,6 @@
 from enum import Enum
 from typing import Any, Union
 
-# TODO:
-# - write tests
-# - clean up repo
 
 __all__ = [
     "StyledText",
@@ -138,7 +135,7 @@ def __init__(self, code: str, lang: str = None):
         self.__lang = lang if lang else ""
 
     def __str__(self) -> str:
-        return f"```{self.__lang}\n" + self.__code + "\n```"
+        return f"```{self.__lang}\n{self.__code}\n```"
 
 
 # ---- URLs ----

docs/conf.py

@@ -25,7 +25,7 @@
 author = 'classabbyamp, 0x5c'
 
 # The full version, including alpha/beta/rc tags
-release = '{{version}}'
+release = '1.0.0'
 
 
 # -- General configuration ---------------------------------------------------

docs/index.rst

@@ -118,6 +118,12 @@ Timestamps
 Utility Functions
 -----------------
 
+.. NOTE:: Escaping of markdown titled URLs (like this example below) in text is not yet supported!
+
+    .. code-block:: markdown
+
+        [title](https://example.com)
+
 .. autofunction:: escape_everything()
 
 .. autofunction:: escape_markdown()