Skip to content

Speculative move to Markdown #472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: lektor
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion BeeWare.lektorproject
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ url_prefix = /pl_PL/
locale = pl_PL

[packages]
lektor-rst = 0.2.0
lektor-github-repos = 0.1.1
lektor-gravatar = 0.1.2

Expand Down
94 changes: 94 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
[![image](http://beeware.org/static/images/brutus-270.png){width="72px"}](https://beeware.org)

# beeware.github.io

This is the homepage for the [BeeWare project](http://beeware.org).

It is a [Lektor](https://getlektor.com)-based site.

If you want to contribute a modification, you can fork this repository
and submit a pull request. However, **do not fork the master branch** -
fork the [lektor
branch](https://github.com/beeware/beeware.github.io/tree/lektor) and
make changes there instead.

If you want to test out a change before you submit it, create a virtual
environment, and install [Lektor](https://getlektor.com):

$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ python -m pip install lektor

Then from the root directory of the checkout, run:

(venv) $ lektor server

This will [start a webserver](http://127.0.0.1:5000) that will
autoreload whenever you make a change to site content.

## Community

You can talk to the community through:

- [\@pybeeware on Twitter](https://twitter.com/pybeeware)
- BeeWare Gitter channel:
[beeware/general](https://gitter.im/beeware/general)
- [Tickets on the beeware.github.io issue
tracker](https://github.com/beeware/beeware.github.io/issues)

## Contributing

If you find problems with this website, [log them on
GitHub](https://github.com/beeware/beeware.github.io/issues). If you
want to contribute, please [fork the
code](https://github.com/beeware/beeware.github.io/tree/lektor) and
[submit a pull
request](https://github.com/beeware/beeware.github.io/pulls).

Before submitting a pull request, please make sure your forked branch is
up to date with the original branch. To do this:

- set your upstream remote:

$ git remote add upstream https://github.com/beeware/beeware.github.io.git

- make sure you have the latest changes from upstream:

$ git fetch upstream

- rebase your **lektor** branch to **upstream** before pushing to git
and submitting a pull request:

$ git rebase upstream/lektor

## Translating

Want to make BeeWare more accessible to non-English-speakers? Help
translate the site! Steps are as follows:

1. Add language specification to
[BeeWare.lektorproject](https://github.com/beeware/beeware.github.io/blob/lektor/BeeWare.lektorproject).

Fill out the name of the language, its url prefix, and the locale.
Make sure you use the correct [ISO
639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) locale
code - for many countries, it\'s not the same as the national TLD.
For example, the ISO 639-1 Danish locale is \'da\', but Denmark uses
the \'.dk\' TLD.

2. Add an entry for your language to the [Atom
configuration](https://github.com/beeware/beeware.github.io/blob/lektor/configs/atom.ini).

3. Add your first translation, by translating the names for the menus
at the top of each page. Edit [the menus translation
file](https://github.com/beeware/beeware.github.io/blob/lektor/databags/menu.ini),
adding a block for your language.

4. Start adding translations for content pages on the site. Translated
files are at the same directory level as the primary English files,
but have a language suffix. For example, Arabic\'s locale is \'ar\',
so you would add [contents+ar.lr]{.title-ref} wherever the original
file name is [contents.lr]{.title-ref}

A great place to start translating is the [contributing
section](https://beeware.org/contributing/).
108 changes: 0 additions & 108 deletions README.rst

This file was deleted.

8 changes: 0 additions & 8 deletions assets/CONTRIBUTING.md

This file was deleted.

27 changes: 0 additions & 27 deletions assets/LICENSE

This file was deleted.

93 changes: 0 additions & 93 deletions assets/README.rst

This file was deleted.

6 changes: 3 additions & 3 deletions flowblocks/text-block.ini
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ type = markdown

[fields.text]
label = Text
description = reStructuredText
type = rst
description = Markdown
type = markdown

[fields.image]
label = Image
label = Image
type = select
source = record.attachments.images
width = 1/4
Expand Down
4 changes: 2 additions & 2 deletions models/blog-post.ini
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ width = 1/4

[fields.body]
label = Body
description = reStructuredText
type = rst
description = Markdown
type = markdown
4 changes: 2 additions & 2 deletions models/blog.ini
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ type = string

[fields.gutter_top]
label = Gutter top
description = reStructuredText
type = rst
description = Markdown
type = markdown
4 changes: 2 additions & 2 deletions models/event.ini
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,5 @@ type = string

[fields.description]
label = Description
description = reStructuredText
type = rst
description = Markdown
type = markdown
4 changes: 2 additions & 2 deletions models/events.ini
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ type = string

[fields.gutter]
label = Gutter
description = reStructuredText
type = rst
description = Markdown
type = markdown

[children]
model = event
Expand Down
Loading