mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
Added blog
This commit is contained in:
3
docs/api/index.md
Normal file
3
docs/api/index.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Reference
|
||||
|
||||
A reference to the Textual public APIs.
|
||||
4
docs/blog/.authors.yml
Normal file
4
docs/blog/.authors.yml
Normal file
@@ -0,0 +1,4 @@
|
||||
willmcgugan:
|
||||
name: Will McGugan
|
||||
description: CEO / code-monkey
|
||||
avatar: https://github.com/willmcgugan.png
|
||||
3
docs/blog/index.md
Normal file
3
docs/blog/index.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Textual Blog
|
||||
|
||||
Welcome to the Textual blog, where we post about the latest releases and developments in the Textual world.
|
||||
19
docs/blog/posts/helo-world.md
Normal file
19
docs/blog/posts/helo-world.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
draft: false
|
||||
date: 2022-11-06
|
||||
categories:
|
||||
- News
|
||||
authors:
|
||||
- willmcgugan
|
||||
---
|
||||
|
||||
# New Blog
|
||||
|
||||
Welcome to the first post on the Textual blog.
|
||||
|
||||
<!-- more -->
|
||||
|
||||
I plan on using this as a place to make announcements regarding new releases of Textual, and any other relevant news.
|
||||
|
||||
The first piece of news is that we've reorganized this site a little. The Events, Styles, and Widgets references are now under "Reference", and what used to be under "Reference" is now "API" which contains API-level documentation. I hope that's a little clearer than it used to be!
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
# Events
|
||||
|
||||
A reference to Textual [events](../guide/events.md).
|
||||
|
||||
See the links to the left of the page, or in the hamburger menu (three horizontal bars, top left).
|
||||
|
||||
14
docs/help.md
14
docs/help.md
@@ -1,20 +1,16 @@
|
||||
---
|
||||
hide:
|
||||
- navigation
|
||||
---
|
||||
|
||||
# Help
|
||||
|
||||
Here's where to go if you need help with Textual.
|
||||
If you need help with any aspect of Textual, let us know! We would be happy to hear from you.
|
||||
|
||||
## Bugs and feature requests
|
||||
|
||||
Report bugs via GitHub on the Textual [issues](https://github.com/Textualize/textual/issues) page. You can also post feature requests via GitHub issues, but see the [roadmap](./roadmap.md) first.
|
||||
|
||||
## Discord Server
|
||||
|
||||
For more realtime feedback or chat, join our discord server to connect with the [Textual community](https://discord.gg/Enf6Z3qhVr).
|
||||
|
||||
## Forum
|
||||
|
||||
Visit the [Textual forum](https://community.textualize.io/) for Textual (and Rich) discussions.
|
||||
|
||||
## Discord Server
|
||||
|
||||
For more realtime feedback or chat, join our discord server to connect with the [Textual community](https://discord.gg/Enf6Z3qhVr).
|
||||
|
||||
@@ -1,3 +1,35 @@
|
||||
# Reference
|
||||
|
||||
A reference to the Textual public APIs.
|
||||
Welcome to the Textual Reference.
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :octicons-book-16:{ .lg .middle } __Events__
|
||||
|
||||
---
|
||||
|
||||
Events are how Textual communicates with your application.
|
||||
|
||||
:octicons-arrow-right-24: [Events Reference](../events/index.md)
|
||||
|
||||
|
||||
- :octicons-book-16:{ .lg .middle } __Styles__
|
||||
|
||||
---
|
||||
|
||||
All the styles you can use to take your Textual app to the next level.
|
||||
|
||||
[:octicons-arrow-right-24: Styles Reference](../styles/index.md)
|
||||
|
||||
|
||||
- :octicons-book-16:{ .lg .middle } __Widgets__
|
||||
|
||||
---
|
||||
|
||||
How to use the many widgets builtin to Textual.
|
||||
|
||||
:octicons-arrow-right-24: [Widgets Reference](../widgets/index.md)
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
hide:
|
||||
- navigation
|
||||
---
|
||||
|
||||
|
||||
# Roadmap
|
||||
|
||||
We ([textualize.io](https://www.textualize.io/)) are actively building and maintaining Textual.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
# Styles
|
||||
|
||||
A reference to Widget [styles](../guide/styles.md).
|
||||
|
||||
See the links to the left of the page, or in the hamburger menu (three horizontal bars, top left).
|
||||
|
||||
@@ -55,4 +55,4 @@ _No other attributes_
|
||||
|
||||
## See Also
|
||||
|
||||
* [Button](../reference/button.md) code reference
|
||||
* [Button](../api/button.md) code reference
|
||||
|
||||
@@ -29,7 +29,7 @@ The example below shows checkboxes in various states.
|
||||
## Reactive Attributes
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|---------|--------|---------|------------------------------------|
|
||||
| ------- | ------ | ------- | ---------------------------------- |
|
||||
| `value` | `bool` | `False` | The default value of the checkbox. |
|
||||
|
||||
## Messages
|
||||
@@ -43,7 +43,7 @@ The `Checkbox.Changed` message is sent when the checkbox is toggled.
|
||||
#### Attributes
|
||||
|
||||
| attribute | type | purpose |
|
||||
|-----------|--------|--------------------------------|
|
||||
| --------- | ------ | ------------------------------ |
|
||||
| `value` | `bool` | The new value of the checkbox. |
|
||||
|
||||
## Additional Notes
|
||||
@@ -54,4 +54,4 @@ The `Checkbox.Changed` message is sent when the checkbox is toggled.
|
||||
|
||||
## See Also
|
||||
|
||||
- [Checkbox](../reference/checkbox.md) code reference
|
||||
- [Checkbox](../api/checkbox.md) code reference
|
||||
|
||||
@@ -39,4 +39,4 @@ This widget sends no messages.
|
||||
|
||||
## See Also
|
||||
|
||||
* [Footer](../reference/footer.md) code reference
|
||||
* [Footer](../api/footer.md) code reference
|
||||
|
||||
@@ -32,4 +32,4 @@ This widget sends no messages.
|
||||
|
||||
## See Also
|
||||
|
||||
* [Header](../reference/header.md) code reference
|
||||
* [Header](../api/header.md) code reference
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
# Widgets
|
||||
|
||||
A reference to the builtin [widgets](../guide/widgets.md).
|
||||
|
||||
See the links to the left of the page, or in the hamburger menu (three horizontal bars, top left).
|
||||
|
||||
@@ -54,7 +54,7 @@ The `Input.Submitted` message is sent when you press ++enter++ with the text fie
|
||||
#### Attributes
|
||||
|
||||
| attribute | type | purpose |
|
||||
|-----------|-------|----------------------------------|
|
||||
| --------- | ----- | -------------------------------- |
|
||||
| `value` | `str` | The new value in the text input. |
|
||||
|
||||
|
||||
@@ -64,4 +64,4 @@ The `Input.Submitted` message is sent when you press ++enter++ with the text fie
|
||||
|
||||
## See Also
|
||||
|
||||
* [Input](../reference/input.md) code reference
|
||||
* [Input](../api/input.md) code reference
|
||||
|
||||
@@ -31,4 +31,4 @@ This widget sends no messages.
|
||||
|
||||
## See Also
|
||||
|
||||
* [Static](../reference/static.md) code reference
|
||||
* [Static](../api/static.md) code reference
|
||||
|
||||
Reference in New Issue
Block a user