Требования к материалам, для авторов
Для написания статей в сообщество @vp-webdev главное - использовать Markdown.
Теперь подробности :)
Объём статьи не особо важен, главное не слишком маленький. 2000-3000 тысячи знаков - нормально. Если пост разбавлен образцами кода, изображениями, видеороликами или таблицами - это тоже даёт объём статье и чистой писанины может быть меньше.
Могу ли я публиковаться в сообществе?
Если сомневаетесь - посмотрите вот этот пост.
В нём подробно расписаны темы и в целом я объяснил зачем вам это всё надо.
Что важно
Вы должны понимать то, что вы пишите. Если вы непосредственно используете инструмент или технологию, о которой пишите - отлично. Когда вам интересна какая-то тема, вы её изучили и готовы поделиться полученными знаниями - тоже отлично.
В том случае, если вы занимаетесь скажем продвижением - писать об оптимизации запросов к реляционным БД было бы не совсем уместно.
При использовании изображений с чужих сайтов - под каждым изображением оставьте ссылку на сайт.
Ссылку на главное(первое) изображение материала оставляйте в конце материала следующим образом:
*Главное изображение с сайта [kartinki.ru](http://kartinki.ru/page-with-image)*
Если вы пишите о том, как запрограммировать, сверстать или сконфигурировать - пишите образец кода, стилей, вёрстки, конфига и т.п. Как его оформить - написано ниже. Полный листинг кода выкладывайте на https://pastebin.com и оставляйте ссылку в конце материала или в конце части материала, описывающей данный код.
Важно - если используете pastebin - при публикации там кода обязательно указывайте на каком языке он написан, чтобы сработала подсветка синтаксиса.
Почему не https://gist.github.com/ ?
На гитхабе хуже работает подсветка синтаксиса. Если ваш код хорошо читается с gist.github.com - можете хостить код на нём.
Ниже немного о правилах оформления текста и о том, как отправить его на редактуру.
Если вы рассказываете о вёрстке или JavaScript - будет мегакруто, если вы выложите где-нибудь работающий пример. Так как если у кого-то не получится повторить ваш код, опираясь на пост - скатать с реально работающей страницы можно в 99% случаев.
Оформление статьи
Если пост объёмный - его следует поделить на части. Каждая часть должна иметь свой подзаголовок. В Markdown он оформляется при помощи ##.
## Подзаголовок в материале
После двух решеток ставите пробел.
Если текст части материала можно ещё раз поделить на части - используйте подзаголовок следующего уровня ###.
## Подзаголовок в материале
Текст.
### Ещё подзаголовок
Ещё текст.
Для оформления кода используйте по три знака тильда до первой строки кода и после последней:
```
echo 'Hello golos';
```
Выглядеть это будет так:
echo 'Hello golos';
Изображения
Для вставки изображений можно просто поставить в тексте статьи URL изображения.
Загрузить изображение можно на https://imgur.com/
Если изображение шире 800 пикселей - оно будет смасштабировано до 800 пикселей в ширину. Если на изображении есть какие-то мелочи, которые важно разглядеть для понимания материала - следует оставить ссылку на само изображение.
Например:
https://i.imgur.com/XWp0xNl.jpg
[https://i.imgur.com/XWp0xNl.jpg](https://i.imgur.com/XWp0xNl.jpg)
Выглядеть это будет так:
https://i.imgur.com/XWp0xNl.jpg
Если изображение уже 800 пикселей - лучше всего выровнять его по центру:
<center>https://i.imgur.com/XWp0xNl.jpg</center>
[https://i.imgur.com/XWp0xNl.jpg](https://i.imgur.com/XWp0xNl.jpg)
Заценим:
https://i.imgur.com/XWp0xNl.jpg
Таблицы
Сразу пример таблицы:
Язык | Владение | Использование |
---|---|---|
JavaScript | На отлично | Всю жизнь |
PHP | Неплохо | При необходимости |
Scala | Что это? | Никогда |
В Markdown таблица будет выглядеть вот так:
| Язык | Владение | Использование |
| - | - | - |
| JavaScript | На отлично | Всю жизнь |
| PHP | Неплохо | При необходимости |
| Scala | Что это? | Никогда |
Попробуйте вставить её при создании поста.
Ссылки
Если анкором ссылки будет сама ссылка - просто вставляете её в тело поста(например https://www.google.ru) и ссылка станет кликабельной
Если нужен анкор - пишите так:
[Поисковик](https://www.google.ru)
Получится:
Поисковик
Жирный и курсив
Для создания жирного начертания используйте по две звёздочки в начале и конце выделяемого текста.
Предложение с **важным** текстом
Предложение с важным текстом
Курсив - одна точка.
Предложение с *неважным* текстом
Предложение с неважным текстом
Если нужно жирный и курсив - по три точки:
Предложение с ***очень важным*** текстом
Предложение с очень важным текстом
Списки
Похоже на использование заголовков. Можно использовать звёздочки или тире.
Пример:
Деление языков программирования
- Низкий уровень
- C
- C++
- Assembler
- Средний уровень
- Java
- C#
- Высокий уровень
- Python
- Ruby
- JavaScript
- Common Lisp
В разметке это выглядит так, обращайте внимание на пробелы:
### Деление языков программирования
* Низкий уровень
- C
- C++
- Assembler
* Средний уровень
- Java
- C\#
* Высокий уровень
- Python
- Ruby
- JavaScript
- Common Lisp
Цитаты
Цитата выделяется знаком >
Например:
> А вот он сказал...
Во второй строке > необязателен
А вот он сказал...
Во второй строке > необязателен
Соответственно после цитаты отбивайте одну строку, иначе дальнейший текст попадёт в цитату.
Если хотите отбить текст горизонтальной линией, аналог <hr>
- используйте три знака тире ---
Как всё это запомнить
Если вы сходу не запомнили всего этого - используйте редактор https://hackmd.io - в нём всё это реализовано в виде удобного визуального редактора. Разметка будет лаконична и удобна. И не будет горы мусора в виде html тэгов.
И тогда главврач Маргулиц html-разметку запретил (с).
Когда всё готово
Отправляйте мне ссылку с вашей работой на https://hackmd.io в телеграмм https://t.me/tristamoff
В материале первой строчкой напишите желаемый заголовок материала. Но заголовок всё же остаётся на моё усмотрение.
Так же я проверю текст на опечатки и постараюсь исправить все логические и пунктуационные ошибки. Если что-то будет не так - отвечу вам в телеграмме.
Главное изображение с сайта bitcoins.io.ua
Данным постом пингую @heavyhell, @wpclub, @pythono, @mo3golom, @semasping, @maximus00, @zheev, @kwentin, @edgarposter, @mfiyalka, @vnukkarpov, @homoludens, @ladyzarulem и @liga.avtorov,
А так же всех тех, что хочет присоединиться.